Node.js client for the FreeConvert API

A Node.js client for the FreeConvert API. For full details of the FreeConvert API, see the API docs.

Installation

$ npm i @freeconvert/freeconvert-node

Usage

Initialising the client

To initialise the client, you must provide:

• An access token.
• The environment that this token is for (see below for a list of available environments).

Available Environments

LIVE
SANDBOX

/**
 * Load as ESM module:
 */
import FreeConvert from "@freeconvert/freeconvert-node";
import { Environments } from "@freeconvert/freeconvert-node/lib/constants";

// Initialise the client
const client = FreeConvert(
  process.env.FREE_CONVERT_API_KEY,
  Environments.SANDBOX,
  "USER_AGENT", // Optional
);

/**
 * or via require:
 */
const FreeConvert = require("@freeconvert/freeconvert-node");
const constants = require("@freeconvert/freeconvert-node/lib/constants");

// Initialise the client
const client = FreeConvert(
  process.env.FREE_CONVERT_API_KEY,
  constants.Environments.SANDBOX,
  "USER_AGENT", // Optional
);