lincor v0.1.6

Lincor.js - clean JavaScript proxy to Lincor API.

Currently usable in Node.js environment.

Goal

This library aims to allow you to integrate Lincor API functionality into your application the cleanest and easiest possible way. Its object-oriented nature makes it perfectly simple and intuitive. With TypeScript definitions and documentation included, integration is almost a no-brainer - let your IDE do the hard work!

Requirements

At this moment, the library works fully only in Node.js, and thus you need it in your system, alongside with a package manager of your choice.

TODO: tweak the library so that it works in browsers, too.

Installation

Install using your favourite package manager.

Using Yarn

$ yarn add lincor

Using NPM

$ npm i lincor -S

Usage

Require the library in your node.js app, and initialize it using your Lincor credentials.

const lincor = require('lincor')

lincor.init({
  companyname: "enter your company name",
  username: "username goes here",
  password: "password goes here"
})

Documentation

For the complete list of functions, classes and other (with detailed descriptions), see the documentation.

Command Line Interface

This library comes with a CLI as a separate package. See lincor-cli.

Note: Using the CLI is the recommended way to download the list of all objects available for a user.

Reference

This library is a proxy to TruckOnline API, powered by Lincor