/pipl-js

Provides an api client and types for the pipl service

Primary LanguageTypeScript

pipl services

This package provides a standardized layer for accessing pipl services along with data types.

Usage

Installation

Install the service in your own project

npm install @torch-ai/pipl

Initialization

At the top of your application, or in an imported configuration file:

// Import the service definition and environment constants
import Pipl from "@torch-ai/pipl";

// Create an instance of the service
const options = {};
const pipl = new Pipl(process.env.API_KEY, options);
export default pipl;

Calls

try {
  const results = await pipl.search({
    raw_name: "Edison"
  });
} catch (error) {}

License and agreements

This package is provided through an MIT license. Usage of this package is freely available without restriction.

pipl itself has it's own terms of service, and account registration.

Contributing

Installation

Clone the package and install the dependencies.

npm install

Testing

A local file .env file will need to be created with credentials for the api:

API_KEY=****

You may run tests in a continuous watch mode:

npm run-script test:watch

Publishing

Open an issue requesting a version to publish.