npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

headlight-client

v3.1.116

Published

The headlight-client library is an SDK for interacting with [Headlight](http://headlightiq.com/)

Downloads

19

Readme

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"
      ]
    }
}