# statuspage.ts

> Simple Statuspage.io API wrapper

Latest version **0.2.0** (published 2023-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install statuspage.ts
pnpm add statuspage.ts
yarn add statuspage.ts
bun add statuspage.ts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2023-03-29 |
| First published | 2023-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 82.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Timeraa |
| Maintainers | timeraa |
| Keywords | statuspage.io, api, wrapper, typescript |

## Links

- npm: https://www.npmjs.com/package/statuspage.ts
- Repository: https://github.com/timeraa/statuspage.ts
- Homepage: https://github.com/timeraa/statuspage.ts#readme
- Issues: https://github.com/timeraa/statuspage.ts/issues
- Funding: https://github.com/timeraa/statuspage.ts?sponsor=1
- npm.io page: https://npm.io/package/statuspage.ts

## Dependencies (3)

- [ky](https://npm.io/package/ky.md) ^0.33.3
- [true-myth](https://npm.io/package/true-myth.md) ^6.2.0
- [ky-universal](https://npm.io/package/ky-universal.md) ^0.11.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2023-03-29
- 0.1.0 — 2023-03-27

## README

# Statuspage.ts

Statuspage.ts is a simple library for interacting with the [Statuspage.io](https://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.

## Why?

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.

## Important

**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!**

## Installation

```bash
npm install statuspage.ts
```

## Usage

```js
const Statuspage = require("statuspage.ts");

const statuspage = new Statuspage("YOUR_API_KEY");

statuspage.incidents.getAll("YOUR_PAGE_ID").then((incidents) => {
	console.log(incidents);
});
```

### TODO

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](https://developer.statuspage.io/#tag/subscribers)
- [Templates](https://developer.statuspage.io/#tag/templates)
- [Incident Updates](https://developer.statuspage.io/#tag/templates)
- [Incident Subscribers](https://developer.statuspage.io/#tag/incident-subscribers)
- [Incident Postmortem](https://developer.statuspage.io/#tag/incident-postmortem)
- [Components](https://developer.statuspage.io/#tag/components)
  - [Remove Users Page Access](https://developer.statuspage.io/#operation/deletePagesPageIdComponentsComponentIdPageAccessUsers)
  - [Add Users Page Access](https://developer.statuspage.io/#operation/postPagesPageIdComponentsComponentIdPageAccessUsers)
  - [Add Groups Page Access](https://developer.statuspage.io/#operation/deletePagesPageIdComponentsComponentIdPageAccessGroups)
  - [Remove Groups Page Access](https://developer.statuspage.io/#operation/postPagesPageIdComponentsComponentIdPageAccessGroups)
- [Component Groups](https://developer.statuspage.io/#tag/component-groups)

### License

[MIT](LICENSE)

**This project does is not affiliated with Statuspage.io in any way.**

---
_Source: https://npm.io/package/statuspage.ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._