nameparse-js
v1.0.0
Published
A Javascript / Typescript SDK for the www.nameparse.com service.
Downloads
4
Maintainers
Readme
Javascript / Node SDK written in Typescript for the NameParse Service
A fast way to add the www.nameparse.com service into your Javascript / Typescript / Node projects.
Installation
The recommended way to install the NameParse SDK is through Composer.
npm install nameparse-js
Usage
const np = new NameParse({ key: NAMEPARSE_KEY });
const results = await np.parse("Chris Schuld");
console.log(results);
output:
{
id: 'LeMKGGKp2o2yCGQNzLZriW',
name: 'Chris Schuld',
first: 'Chris',
middle: '',
last: 'Schuld',
cached: false
}
Usage with Details
You can also ask the API for the extended details from the parse
const np = new NameParse({ key: NAMEPARSE_KEY, details: true });
const results = await np.parse("Chris Schuld");
console.log(results);
output:
{
id: 'Ax323GGKp212yCGQxLZriW',
name: 'Chris Schuld',
first: 'Chris',
middle: '',
last: 'Schuld',
details: {
given: 'Chris',
sur: 'Schuld',
middle: '',
title: '',
initials: '',
suffix: '',
precursor: ''
},
cached: false
}
Tests
Tests are executed via Jest.
npm run test