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:
; ;;; 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.
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"
]
}
}