Splight TypeScript Library

The Splight TypeScript library provides convenient access to the Splight API from applications written in TypeScript both in the client and the server.

Release

IMPORTANT MESSAGE: Try to avoid changing directly the package.json version to release. Use the npm version command as follows

npm version prerelease

This will generate a prerelease version (X.X.X-1) and when you push the package.json changes will be reflected automatically. In case you found an error try with a directory without changes in progress.

git reset
git stash
npm version prerelease
git stash apply

Usage

First, import setup from @splightplatform/splight-lib-ts. Then, you can create a splight object by calling setup.configure(). Optionally, you may pass the authentication headers to be used for making requests to the API. If running in Node, configure will try to read your authentication keys from the SPLIGHT_ACCESS_ID and SPLIGHT_ACCESS_KEY environment variables.

import setup from '@splightplatform/splight-lib-ts';

const splight = setup.configure();

const attribute = await splight.engine.attributes.create({
  name: 'test attribute',
});

const { results: assets, next: nextAssetPage } =
  await splight.engine.assets.list();