# tsmi

> Better Misskey API Client for TypeScript/JavaScript

Latest version **0.4.2** (published 2023-08-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install tsmi
pnpm add tsmi
yarn add tsmi
bun add tsmi
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.2 |
| Published | 2023-08-17 |
| First published | 2023-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 41.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | allianaab2m |

## Links

- npm: https://www.npmjs.com/package/tsmi
- Repository: https://github.com/Allianaab2m/tsmi
- Homepage: https://github.com/Allianaab2m/tsmi#readme
- Issues: https://github.com/Allianaab2m/tsmi/issues
- npm.io page: https://npm.io/package/tsmi

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^8.13.0
- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [axios](https://npm.io/package/axios.md) ^1.4.0
- [events](https://npm.io/package/events.md) ^3.3.0

## Recent versions

- 0.4.2 (latest) — 2023-08-17
- 0.4.1 — 2023-08-08
- 0.4.0 — 2023-08-08
- 0.3.3 — 2023-08-07
- 0.3.2 — 2023-08-07
- 0.3.1 — 2023-08-07
- 0.2.1 — 2023-08-07
- 0.2.0 — 2023-08-06

## README

# tsmi

Better Misskey API Client for TypeScript/JavaScript

## Thanks

- [MiPA](https://github.com/yupix/MiPA) and
  [MiPAC](https://github.com/yupix/MiPAC) have been helpful in many of the tsmi
  implementations.
  - Thanks also to [Discord.py](https://github.com/Rapptz/discord.py), the
    source of MiPA(C) implementation.
- [misskey-js](https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js)

## Usage

```js
import Client from "tsmi";

const client = new Client({
  host: "https://<your-misskey-server-url>",
  token: "<YOUR_TOKEN_HERE>",
  channels: ["main", "localTimeline", "homeTimeline"],
});

client.once("ready", async (me) => {
  console.log("Client ready!");
  const user = await me.user.getMe();
  console.log("Logged in with @", user.name);
});

client.on("noteCreate", (note, timeline) => {
  if (timeline === "localTimeline") {
    console.log(note); // Only take local timeline notes
  }
});
```

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