❤
npm
Sign UpSign In

headlight-client
TypeScript icon, indicating that this package has built-in type declarations

3.1.116 • Public • Published

headlight-client

The headlight-client library is an SDK for interacting with Headlight

It contains the following resources:
HTML API Documentation /docs
Browserify es6 bundle /dist/headlight-bundle
NodeJS Typescript Client /node
AngularJS Typescript Client /angularjs
Angular6 Typescript Client /angular6
Unit tests /node/test

Getting Started

Setup your project for typescript.

Then install this package:

npm install headlight-client

Create an example.ts script file:

import * as Headlight from 'headlight-client';
 
const _ServerURL = 'https://headlightqa.paviasystems.com';
const _UserName = 'user';
const _Password = 'password123';
 
async function main()
{
    var client = new Headlight.Client(_ServerURL);
    let session = await client.login(_UserName, _Password);
 
    let userApi = client.API(Headlight.API.UserApi);
    let record = await userApi.read(client.UserSession.UserID);
 
    console.log(`My name is ${record.NameFirst} ${record.NameLast}`);
}
 
main();
 

Execute your script with:

ts-node example.ts

Using in the browser

Just include the headlight-bundle.min.js file in your html document. You can then reference the client under the "Headlight" namespace.

<html>
  <head>
    <script src="headlight-bundle.min.js"></script> 
  </head>
  <body>
    <script type="text/javascript">
        var client = new Headlight.Client("https://headlightqa.paviasystems.com");
        client.login("user", "password123")
            .then((session) => {
                console.log(session);
            });
    </script> 
  </body>
</html>

Using as a bower component

bower.json

{
  ...
  "dependencies": {
    "headlight-client": "https://github.com/paviasystems/headlight-client.git"
  },
  "overrides": {
    "headlight-client": {
      "main": [
        "dist/headlight-bundle.min.js"
      ]
    }
}

Dependencies (2)

Dev Dependencies (35)

Package Sidebar

Install

npm i headlight-client

Repository

github.com/paviasystems/headlight-client

Homepage

github.com/paviasystems/headlight-client#readme

Weekly Downloads

2

Version

3.1.116

License

ISC

Unpacked Size

35.9 MB

Total Files

439

Last publish

Collaborators

  • jasonhillier
  • stevenvelozo
  • wisam82
Try on RunKit
Report malware