company-api
An API for aggregating NUM Contacts Module and Images Module Records into a single object using the NUM Protocol.
Installation For Local Testing
git clone git@github.com:NUMtechnology/company-api.git
cd company-api
npm install
- Open
test/index.html
in your browser.
Installation For Use In An Application
npm install -s company-api
Simple Application Usage in JavaScript
const companyApi = require('company-api');
const api = companyApi.createCompanyApi();
api.lookupDomain('numexample.com').then((result) => {
console.log(JSON.stringify(result));
}, (err)=>{
console.error('ERROR: ', JSON.stringify(err));
});
Simple Application Usage in TypeScript
import { createCompanyApi } from 'company-api';
const api = createCompanyApi();
api.lookupDomain('numexample.com').then((result) => {
console.log(JSON.stringify(result));
}, (err)=>{
console.error('ERROR: ', JSON.stringify(err));
});
Controlling the Recursion Levels
import { createCompanyApi, CompanyApiOptions } from 'company-api';
const api = createCompanyApi();
const versionMap = new Map<number, string>();
versionMap.set(1,'2');
versionMap.set(3,'1.5');
const options = new CompanyApiOptions(
2,
1,
versionMap
);
api.lookupDomain('numexample.com', options).then((result) => {
console.log(JSON.stringify(result));
}, (err)=>{
console.error('ERROR: ', JSON.stringify(err));
});
Supplying an Existing NUMClient Object
If you already have a NUMClient object you can re-use it.
import { createClient } from 'num-client';
import { createCompanyApi } from 'company-api';
const existingClient = createClient();
const api = createCompanyApi(existingClient);
api.lookupDomain('numexample.com').then((result) => {
console.log(JSON.stringify(result));
}, (err)=>{
console.error('ERROR: ', JSON.stringify(err));
});