pixiv-app-api


> Promise based pixiv API client

Inspired by upbit/pixivpy: Pixiv API for Python.

Features

- Promise based
- Converts the output json keys to camelCase
- Converts the parameters to snakeCase
- Supports API without login

Install

``
$ npm install --save pixiv-app-api
`

Usage

`js
import PixivAppApi from 'pixiv-app-api' //const PixivAppApi = require("pixiv-app-api")
import pixivImg from 'pixiv-img' //const pixivImg = require("pixiv-img")
const pixiv = new PixivAppApi(process.env.NAME, process.env.PASSWORD, {
camelcaseKeys: true,
})

;(async () => {
await pixiv.login()
const json = await pixiv.searchIllust('艦これ10000users入り')
await pixivImg(json.illusts[0].imageUrls.large)
console.log('finish')
})()
`

Typescript

All functions will return either a camelCaseType or a snake_case_type depending on the value of camelcaseKeys.
For example:

`ts
//const pixiv = new PixivAppApi(process.env.NAME, process.env.PASSWORD, {camelcaseKeys: true})
interface PixivClient = {
accessToken: string
expiresIn: number
tokenType: string
scope: string
refreshToken: string
user: PixivClientUser
deviceToken: string
}

//const pixiv = new PixivAppApi(process.env.NAME, process.env.PASSWORD, {camelcaseKeys: false})
interface Pixiv_Client = {
access_token: string
expires_in: number
token_type: string
scope: string
refresh_token: string
user: Pixiv_Client_User
device_token: string
}
`

API

#### constructor(username?: string, password?: string, options? {camelcaseKeys?: boolean})

Creates a new PixivAppApi object. camelcaseKeys defaults to true if it is omitted.

#### login(username?: string, password?: string): Promise

Logs into the API.

#### authInfo(): PixivClient

Gets your authInfo.

`ts
interface PixivClient {
accessToken: string
expiresIn: number
tokenType: string
scope: string
refreshToken: string
user: PixivClientUser
deviceToken: string
}
`

#### makeIterable(resp: Object): AsyncIterable