README.md

Typescript Client Library for Affinda Resume Parser API

• Installation
• Quickstart
• API reference
• Samples
• Troubleshooting

Generated using autorest and autorest.typescript.

Package (NPM)

Installation

npm install @affinda/affinda

API Version Compatibility

The Affinda API is currently on v3, with breaking changes meant the release of new versions of the client library. Please see below for which versions are compatible with which API version.

Affinda API version	affinda-typescript versions
v2	0.1.0 - 5.x.x
v3	>= 6.x.x

Quickstart

Currently supported environments

• LTS versions of Node.js
• Latest versions of Safari, Chrome, Edge, and Firefox.

Install the affinda package

Install the Service client library for JavaScript with npm:

npm install @affinda/affinda

or build from source:

git clone git@github.com:affinda/affinda-typescript.git
npm install
npm build

Example parsing a resume:

const { AffindaCredential, AffindaAPI } = require("@affinda/affinda");
const fs = require("fs");

const credential = new AffindaCredential("REPLACE_TOKEN");
const client = new AffindaAPI(credential);
const readStream = fs.createReadStream("PATH_TO_RESUME.pdf");

client
  .createDocument({ file: readStream })
  .then((result) => {
    console.log("Returned data:");
    console.dir(result);
  })
  .catch((err) => {
    console.log("An error occurred:");
    console.error(err);
  });

// Can also use a URL:

client
  .createDocument({
    url: "https://api.affinda.com/static/sample_resumes/example.docx",
  })
  .then((result) => {
    console.log("Returned data:");
    console.dir(result);
  })
  .catch((err) => {
    console.log("An error occurred:");
    console.error(err);
  });

API reference

A full API reference generated with typedoc is available here

Samples

Samples are available for NodeJS and also for javascript intended for use in a browser.

Troubleshooting

Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.