README.md

A StatusCake API Library

Functions and type definitions to make it easier to work with the StatusCake API.

Example of Use

import { StatusCake, getTests, Test } from 'statuscakejs'

const statusCake = new StatusCake(<username>, <API key>)

getTests(statusCake)
.then((data: Array<Test>) => console.log(JSON.stringify(data)))
// [{"TestID":3208271,"Paused":false,"TestType":"HTTP", ...

See src/demo.ts for more examples.

See the StatusCake API Documentation for details about fields.

Installation

npm i statuscakejs