README.md

qiita-js-2

Modern Qiita v2 API client for Node/Browser

使い方

パッケージををインストール

npm i qiita-js-2 --save

トークンを取得

Qiitaのアプリケーションページを開き、新しいアクセストークンを発行します。

アクセストークンを発行します。説明と、必要に応じてスコープを付与し発行してください。

生成されたアクセストークンをコピーして保存してください。このトークンは以下で利用します。

利用する

// 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);
});

利用可能なすべてのメソッドのドキュメントはこちらからご覧いただけます。

開発

開発に必要なパッケージをインストールします

yarn --pure-lockfile

下記のコマンドでビルドします

yarn run test       # テストを実行します
yarn run build      # JSをビルドします
yarn run docs:build # ドキュメントを生成します。

Maintainers

Neetshin

License

MIT