Danbooru2 | zen-bridge

A Booru implementation for sites running Danbooru version 2

Hierarchy

Booru
- Danbooru2

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Danbooru2(base: string, credentials?: Credentials): Danbooru2

Inherited from Booru.constructor
- Defined in lib/booru.ts:29
Create instance of a specific booru site

Parameters
- base: string
  
  Base URI of a booru site
- Optional credentials: Credentials
  
  Credentials for authentication on the site
Returns Danbooru2

Properties

base

base: string

Base URI of a booru site

Protected converter

converter: Converter = Danbooru2Converter

Optional options

options: Map<string, any>

Stores any global options for the booru. This has different members based on the booru type.

Protected Optional pCredentials

pCredentials: Credentials

Stores credentials for authentication. From outside the class, use credentials accessor or set it in the constructor directly.

Protected uriBuilder

uriBuilder: UriBuilder = Danbooru2UriBuilder

xml

xml: false = false

Accessors

credentials

set credentials(data: Credentials | undefined): void

Inherited from Booru.credentials
- Defined in lib/booru.ts:43
Set credentials object to use for authentication on the site. See Credentials for more about required fields.

Parameters
- data: Credentials | undefined
Returns void

Protected fetchOptions

get fetchOptions(): object

Overrides Booru.fetchOptions
- Defined in lib/booru-types/danbooru2.ts:91
Returns object

loggedIn

get loggedIn(): boolean

Inherited from Booru.loggedIn
- Defined in lib/booru.ts:56
Check if the auth credentials are set

Returns boolean

Methods

artist

artist(id: number | string): Promise<Artist>

Inherited from Booru.artist
- Defined in lib/booru.ts:98
Get a single Artist by ID

Parameters
- id: number | string
  
  ID of the artist
Returns Promise<Artist>

artists

artists(query: Artists): Promise<Artist[]>

Inherited from Booru.artists
- Defined in lib/booru.ts:106
Get an array of Artists that match a query

Parameters
- query: Artists
  
  Artists search query object
Returns Promise<Artist[]>

comment

comment(id: number | string): Promise<Comment>

Inherited from Booru.comment
- Defined in lib/booru.ts:114
Get a single Comment by ID

Parameters
- id: number | string
  
  ID of the comment
Returns Promise<Comment>

comments

comments(query: Comments): Promise<Comment[]>
comments(post: Post): Promise<Post>

Inherited from Booru.comments
- Defined in lib/booru.ts:122
Get an array of Comments that match a query

Parameters
- query: Comments
  
  Comments search query object
Returns Promise<Comment[]>
Inherited from Booru.comments
- Defined in lib/booru.ts:128
Get back the Post you passed in with the comments field populated

Parameters
- post: Post
  
  The post to find comments for
Returns Promise<Post>

favorite

favorite(id: number): Promise<boolean>

Overrides Booru.favorite
- Defined in lib/booru-types/danbooru2.ts:47
Parameters
- id: number
Returns Promise<boolean>

Protected fetch

fetch(path: string, config?: undefined | object): Promise<any>

Inherited from Booru.fetch
- Defined in lib/booru.ts:241
GET an API call result as an object

Parameters
- path: string
  
  Part of the URI appended to the base
- Optional config: undefined | object
  
  Axios config object
Returns Promise<any>

Protected genericQuery

genericQuery(type: string, query: Query.Any): Promise<any[]>

Inherited from Booru.genericQuery
- Defined in lib/booru.ts:252
Parameters
- type: string
- query: Query.Any
Returns Promise<any[]>

Protected genericSingle

genericSingle(type: string, id: number | string): Promise<any>

Inherited from Booru.genericSingle
- Defined in lib/booru.ts:245
Parameters
- type: string
- id: number | string
Returns Promise<any>

note

note(id: number | string): Promise<Note>

Inherited from Booru.note
- Defined in lib/booru.ts:153
Get a single Note by ID

Parameters
- id: number | string
  
  ID of the note
Returns Promise<Note>

notes

notes(query: Notes): Promise<Note[]>
notes(post: Post): Promise<Post>

Inherited from Booru.notes
- Defined in lib/booru.ts:161
Get an array of Notes that match a query

Parameters
- query: Notes
  
  Notes search query object
Returns Promise<Note[]>
Inherited from Booru.notes
- Defined in lib/booru.ts:167
Get back the Post you passed in with the notes field populated

Parameters
- post: Post
  
  The post to find notes for
Returns Promise<Post>

pool

pool(id: number): Promise<Pool>

Overrides Booru.pool
- Defined in lib/booru-types/danbooru2.ts:36
Parameters
- id: number
Returns Promise<Pool>

pools

pools(query: Pools): Promise<Pool[]>

Inherited from Booru.pools
- Defined in lib/booru.ts:200
Get an array of Pools that match a query

Parameters
- query: Pools
  
  Pools search query object
Returns Promise<Pool[]>

post

post(id: number | string): Promise<Post>

Inherited from Booru.post
- Defined in lib/booru.ts:68
Get a single Post by ID

Parameters
- id: number | string
  
  ID of the post
Returns Promise<Post>

posts

posts(query: Posts): Promise<Post[]>

Overrides Booru.posts
- Defined in lib/booru-types/danbooru2.ts:25
Parameters
- query: Posts
Returns Promise<Post[]>

unfavorite

unfavorite(id: number): Promise<boolean>

Overrides Booru.unfavorite
- Defined in lib/booru-types/danbooru2.ts:69
Parameters
- id: number
Returns Promise<boolean>

user

user(id: number | string): Promise<User>

Inherited from Booru.user
- Defined in lib/booru.ts:208
Get a single User by ID

Parameters
- id: number | string
  
  ID of the user
Returns Promise<User>

users

users(query: Users): Promise<User[]>

Inherited from Booru.users
- Defined in lib/booru.ts:216
Get an array of Users that match a query

Parameters
- query: Users
  
  Users search query object
Returns Promise<User[]>

wiki

wiki(id: number | string): Promise<Wiki>

Inherited from Booru.wiki
- Defined in lib/booru.ts:224
Get a single Wiki page by ID

Parameters
- id: number | string
  
  ID of the wiki page
Returns Promise<Wiki>

wikis

wikis(query: Wikis): Promise<Wiki[]>

Inherited from Booru.wikis
- Defined in lib/booru.ts:232
Get an array of Wikis that match a query

Parameters
- query: Wikis
  
  Wikis search query object
Returns Promise<Wiki[]>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

base: string

Optional credentials: Credentials

Returns Danbooru2

Properties

base

Protected converter

Optional options

Protected Optional pCredentials

Protected uriBuilder

xml

Accessors

credentials

Parameters

data: Credentials | undefined

Returns void

Protected fetchOptions

Returns object

loggedIn

Returns boolean

Methods

artist

Parameters

id: number | string

Returns Promise<Artist>

artists

Parameters

query: Artists

Returns Promise<Artist[]>

comment

Parameters

id: number | string

Returns Promise<Comment>

comments

Parameters

query: Comments

Returns Promise<Comment[]>

Parameters

post: Post

Returns Promise<Post>

favorite

Parameters

id: number

Returns Promise<boolean>

Protected fetch

Parameters

path: string

Optional config: undefined | object

Returns Promise<any>

Protected genericQuery

Parameters

type: string

query: Query.Any

Returns Promise<any[]>

Protected genericSingle

Parameters

type: string

id: number | string

Returns Promise<any>

note

Parameters

id: number | string

Returns Promise<Note>

notes

Parameters

query: Notes

Returns Promise<Note[]>

Parameters

post: Post

Returns Promise<Post>

pool

Parameters