Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

highway-api

smartmonkeyio4MITdeprecated2.6.4TypeScript support: included

Moved permanently to @smartmonkey/planner

This package allows the users to easily integrate Highway services in their code.

api, smartmonkey, services

readme

Build Status codecov/

Installation

You can add the library using npm or yarn:

npm install highway-api --save

or:

yarn add highway-api

Quickstart

To use Highway services you need to create a User and an API Key in our site: https://highway.smartmonkey.io

Now you can use the services by just using:

const { createHighway } = require("highway-api");
const highway = createHighway(YOUR_API_KEY);

Running tests

To run test you'll need to declare an environment variable HIGHWAY_PRIVATE_KEY with a working key created in our webpage (You can just move .env-example to .env). Then just run the tests with:

npm run test