# node-shiki

> API wrapper for the https://shikimori.one/

Latest version **1.0.2** (published 2020-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-shiki
pnpm add node-shiki
yarn add node-shiki
bun add node-shiki
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-12-15 |
| First published | 2020-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 1 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | https://github.com/dddoogg226 |
| Maintainers | dddoogg226 |
| Keywords | shikimori, api, sdk, wrapper, node, js |

## Links

- npm: https://www.npmjs.com/package/node-shiki
- Repository: https://github.com/dddoogg226/node-shiki
- Homepage: https://github.com/dddoogg226/node-shiki#readme
- Issues: https://github.com/dddoogg226/node-shiki/issues
- npm.io page: https://npm.io/package/node-shiki

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) >=2.6.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-12-15
- 1.0.1 — 2020-07-16
- 1.0.0 — 2020-07-04

## README

# node-shiki
API wrapper for the [Shikimori.one](https://shikimori.one/).

### NPM
```
npm i node-shiki
```

## Example usage
```js
const Shikimori = require('node-shiki')

const shiki = new Shikimori({
  appName: 'APPLICATION_NAME', // Default value 'null'
  token: 'ACCESS_TOKEN', // Default value 'null'
  ver2: false // Default value 'true'
})

shiki.setOptions({ apiUrl: 'API_URL' }) // Default value 'https://shikimori.one/api'

async function run() {
  const res = await shiki.post('users/:topic_id/ignore', { // Request to https://shikimori.one/api/v2/users/82468/ignore
    topic_id: 82468,
    ver2: true // Set this paramete for v2 API
  })

  console.log(res)
}

run().catch(console.error)
```

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