https://github.com/neet/qiita-js-2
Modern Qiita v2 API client for Node/Browser
https://github.com/neet/qiita-js-2
asynciterator qiita rest-client
Last synced: about 1 month ago
JSON representation
Modern Qiita v2 API client for Node/Browser
- Host: GitHub
- URL: https://github.com/neet/qiita-js-2
- Owner: neet
- License: mit
- Created: 2018-06-06T14:54:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-23T08:13:39.000Z (over 7 years ago)
- Last Synced: 2025-03-02T18:48:58.650Z (over 1 year ago)
- Topics: asynciterator, qiita, rest-client
- Language: TypeScript
- Homepage: https://neet.github.io/qiita-js-2
- Size: 377 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qiita-js-2
[](https://www.npmjs.com/package/qiita-js-2)
[](https://travis-ci.com/neet/qiita-js-2)
[](https://codeclimate.com/github/neet/qiita-js-2/maintainability)
Modern Qiita v2 API client for Node/Browser
## 使い方
### パッケージををインストール
```
npm i qiita-js-2 --save
```
### トークンを取得
Qiitaの[アプリケーションページ](https://qiita.com/settings/applications)を開き、新しいアクセストークンを発行します。
アクセストークンを発行します。説明と、必要に応じてスコープを付与し発行してください。
生成されたアクセストークンをコピーして保存してください。このトークンは以下で利用します。
### 利用する
```ts
// Node.js
const { Qiita } = require('qiita-js-2');
// TypeScript あるいは Babel
import { Qiita } from 'qiita-js-2';
const client = new Qiita({
token: 'ここにトークンを指定します',
});
// 例: ユーザーを取得する
client.fetchUser('neetshin').then((user) => {
console.log(user);
})
// 例: 新規投稿をする
client.createItem({
title: '新しい投稿',
body: 'これは新しい投稿です',
tags: [{ name: 'Test', version: '0.0.1' }],
gist: false,
twitter: false,
private: false,
}).then((newItem) => {
console.log(newItem);
});
```
利用可能なすべてのメソッドのドキュメントは[こちらからご覧いただけます](https://neet.github.io/qiita-js-2/classes/_client_qiita_.qiita.html)。
## 開発
開発に必要なパッケージをインストールします
```
yarn --pure-lockfile
```
下記のコマンドでビルドします
```
yarn run test # テストを実行します
yarn run build # JSをビルドします
yarn run docs:build # ドキュメントを生成します。
```
## Maintainers
## License
MIT
