Simple Statuspage.io API wrapper
npm install statuspage.tsStatuspage.ts is a simple library for interacting with the Statuspage.io API.
> NOTE: This library may have bugs and is/can not be fully tested. Statuspage.io's documentation is pretty outdated as well so some types may not be correct. If you find any issues, please open an issue or PR.
I wanted to create a simple library for interacting with the Statuspage API with Type Safety. I could not find any libraries that were up to date and/or had a good API. So I created this one.
This libary does not have a automatic test suite as Statuspage's documentation is not accurate and I do not believe mocking the API is a good idea. Suggestions are welcome!
``bash`
npm install statuspage.ts
`js
const Statuspage = require("statuspage.ts");
const statuspage = new Statuspage("YOUR_API_KEY");
statuspage.incidents.getAll("YOUR_PAGE_ID").then((incidents) => {
console.log(incidents);
});
``
These functionalities are not yet implemented. If you would like to help, please open a PR.
- Change return types of objects to camelCase
- Convert date strings to unix timestamps
- Subscribers
- Templates
- Incident Updates
- Incident Subscribers
- Incident Postmortem
- Components
- Remove Users Page Access
- Add Users Page Access
- Add Groups Page Access
- Remove Groups Page Access
- Component Groups
This project does is not affiliated with Statuspage.io in any way.