Node SDK for yuque

Install

npm i @yuque/sdk --save

Usage

constSDK=require('@yuque/sdk');constclient=newSDK({token: '<YOUR TOKEN>',// other options});constresult=awaitclient.users.get();console.log(result);// apisconst{ users, groups, repos, docs }=client;

Options

/** * @param {Object} options - opts * @param {String} options.token - yuque token, https://www.yuque.com/settings/tokens * @param {String} [options.endpoint] - yuque endpoint * @param {String} [options.userAgent] - request user-agent * @param {Object} [options.requestOpts] - default request options of [urllib](https://www.npmjs.com/package/urllib) * @param {Function} [options.handler] - special how to handler response */

by default, will return response.data.data, you can custom it by handler:

newSDK({handler(res){// should handler error yourselfif(res.status!==200){consterr=newError(res.data.message);/* istanbul ignore next */err.status=res.data.status||res.status;err.code=res.data.code;err.data=res;throwerr;}// return whatever you wantconst{ data, abilities }=res.data;returndata;},});

Debug

$http_proxy=http://127.0.0.1:8888 TOKEN=<YOUR_TOKEN> npm test

API

see Yuque API Docs for more details.

users

see the source.

groups

see the source.

repos

see the source.

docs

see the source.

TODO

• API docs
• JSDocs definition for result info
• add d.ts or refactor to TypeScript