zen-bridge

Index

Modules

"jshashes"

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Any

Type compatibile with any Query interface

comparerCallback

comparerCallback: function

Describes a function that test elements of BooruResult.data for uniqueness. See one of the builtInComparers for an example.

param: current: The current element being tested
param: data: The array to test against
returns: True if the element is unique

Type declaration

- (current: T, data: T[]): boolean
- Parameters
  - current: T
  - data: T[]
  Returns boolean

range

range: [number | undefined, number | undefined]

rating

rating: "safe" | "questionable" | "explicit"

Variables

Const b

b: Moebooru = new Moebooru('http://konachan.net')

Const bridge

bridge: ZenBridge = new ZenBridge([db, kc])

Const db

db: Danbooru2 = new Danbooru2('https://danbooru.donmai.us')

Const kc

kc: Moebooru = new Moebooru('http://konachan.net')

Functions

convertRating

convertRating(postRating: string, form?: string): rating

- Defined in lib/utils/rating-converter.ts:8
Converts various representations of post ratings to the ZenBridge rating type

Parameters
- postRating: string
  
  Post rating received from booru
- Default value form: string = "char"
  
  Form of the rating
Returns rating

convertXml

convertXml(xml: string): Promise<any>

- Defined in lib/utils/xml-converter.ts:9
Converts a XML-based booru API response to an object

Parameters
- xml: string
  
  XML data to convert
Returns Promise<any>

dataFetcher

dataFetcher(base: string, path: string, xml?: boolean, config?: object): Promise<any>

- Defined in lib/utils/data-fetcher.ts:4
Parameters
- base: string
- path: string
- Default value xml: boolean = false
- Default value config: object = {}
Returns Promise<any>

login

- Defined in lib/booru-types/danbooru2.spec.ts:7
Returns void

Object literals

Const Danbooru2Converter

Danbooru2Converter: object

artist

artist(data: any): Artist

- Defined in lib/booru-types/danbooru2.ts:312
Parameters
- data: any
Returns Artist

comment

comment(data: any): Comment

- Defined in lib/booru-types/danbooru2.ts:277
Parameters
- data: any
Returns Comment

note

note(data: any): Note

- Defined in lib/booru-types/danbooru2.ts:291
Parameters
- data: any
Returns Note

pool

pool(data: any): Pool

- Defined in lib/booru-types/danbooru2.ts:327
Parameters
- data: any
Returns Pool

post

post(data: any): Post

- Defined in lib/booru-types/danbooru2.ts:222
Parameters
- data: any
Returns Post

user

user(data: any): User

- Defined in lib/booru-types/danbooru2.ts:269
Parameters
- data: any
Returns User

wiki

wiki(data: any): Wiki

- Defined in lib/booru-types/danbooru2.ts:343
Parameters
- data: any
Returns Wiki

Const Danbooru2UriBuilder

Danbooru2UriBuilder: object

artist

artist(id: number): string

- Defined in lib/booru-types/danbooru2.ts:130
Parameters
- id: number
Returns string

artists

artists(query: Artists): string

- Defined in lib/booru-types/danbooru2.ts:133
Parameters
- query: Artists
Returns string

comment

comment(id: number): string

- Defined in lib/booru-types/danbooru2.ts:142
Parameters
- id: number
Returns string

comments

comments(query: Comments): string

- Defined in lib/booru-types/danbooru2.ts:145
Parameters
- query: Comments
Returns string

favorite

favorite(id: number): string

- Defined in lib/booru-types/danbooru2.ts:124
Parameters
- id: number
Returns string

note

note(id: number): string

- Defined in lib/booru-types/danbooru2.ts:158
Parameters
- id: number
Returns string

notes

notes(query: Notes): string

- Defined in lib/booru-types/danbooru2.ts:161
Parameters
- query: Notes
Returns string

pool

pool(id: number): string

- Defined in lib/booru-types/danbooru2.ts:172
Parameters
- id: number
Returns string

pools

pools(query: Pools): string

- Defined in lib/booru-types/danbooru2.ts:175
Parameters
- query: Pools
Returns string

post

post(id: number): string

- Defined in lib/booru-types/danbooru2.ts:104
Parameters
- id: number
Returns string

posts

posts(query: Posts): string

- Defined in lib/booru-types/danbooru2.ts:107
Parameters
- query: Posts
Returns string

unfavorite

unfavorite(id: number): string

- Defined in lib/booru-types/danbooru2.ts:127
Parameters
- id: number
Returns string

user

user(id: number): string

- Defined in lib/booru-types/danbooru2.ts:186
Parameters
- id: number
Returns string

users

users(query: Users): string

- Defined in lib/booru-types/danbooru2.ts:189
Parameters
- query: Users
Returns string

wiki

wiki(id: number): string

- Defined in lib/booru-types/danbooru2.ts:204
Parameters
- id: number
Returns string

wikis

wikis(query: Wikis): string

- Defined in lib/booru-types/danbooru2.ts:207
Parameters
- query: Wikis
Returns string

Const MoebooruConverter

MoebooruConverter: object

artist

artist(data: any): Artist

- Defined in lib/booru-types/moebooru.ts:344
Parameters
- data: any
Returns Artist

comment

comment(data: any): Comment

- Defined in lib/booru-types/moebooru.ts:312
Parameters
- data: any
Returns Comment

note

note(data: any): Note

- Defined in lib/booru-types/moebooru.ts:324
Parameters
- data: any
Returns Note

pool

pool(data: any): Pool

- Defined in lib/booru-types/moebooru.ts:353
Parameters
- data: any
Returns Pool

post

post(__namedParameters: object): Post

- Defined in lib/booru-types/moebooru.ts:245
Parameters
- __namedParameters: object
  - data: any
  - poolPostArray: any[]
  - tagMap: object
    - [i: string]: string
Returns Post

user

user(data: any): User

- Defined in lib/booru-types/moebooru.ts:306
Parameters
- data: any
Returns User

wiki

wiki(data: any): Wiki

- Defined in lib/booru-types/moebooru.ts:367
Parameters
- data: any
Returns Wiki

Const MoebooruUriBuilder

MoebooruUriBuilder: object

artists

artists(query: Artists): string

- Defined in lib/booru-types/moebooru.ts:180
Parameters
- query: Artists
Returns string

comment

comment(id: number): string

- Defined in lib/booru-types/moebooru.ts:189
Parameters
- id: number
Returns string

comments

comments(query: Comments): string

- Defined in lib/booru-types/moebooru.ts:192
Parameters
- query: Comments
Returns string

notes

notes(query: Notes): string

- Defined in lib/booru-types/moebooru.ts:200
Parameters
- query: Notes
Returns string

pool

pool(id: number): string

- Defined in lib/booru-types/moebooru.ts:211
Parameters
- id: number
Returns string

pools

pools(query: Pools): string

- Defined in lib/booru-types/moebooru.ts:214
Parameters
- query: Pools
Returns string

post

post(id: number): string

- Defined in lib/booru-types/moebooru.ts:156
Parameters
- id: number
Returns string

posts

posts(query: Posts): string

- Defined in lib/booru-types/moebooru.ts:159
Parameters
- query: Posts
Returns string

user

user(id: number): string

- Defined in lib/booru-types/moebooru.ts:222
Parameters
- id: number
Returns string

users

users(query: Users): string

- Defined in lib/booru-types/moebooru.ts:225
Parameters
- query: Users
Returns string

vote

vote(id: number, score: number): string

- Defined in lib/booru-types/moebooru.ts:177
Parameters
- id: number
- score: number
Returns string

wikis

wikis(query: Wikis): string

- Defined in lib/booru-types/moebooru.ts:233
Parameters
- query: Wikis
Returns string

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Any

comparerCallback

Type declaration

Parameters

current: T

data: T[]

Returns boolean

range

rating

Variables

Const b

Const bridge

Const db

Const kc

Functions

convertRating

Parameters

postRating: string

Default value form: string = "char"

Returns rating

convertXml

Parameters

xml: string

Returns Promise<any>

dataFetcher

Parameters

base: string

path: string

Default value xml: boolean = false

Default value config: object = {}

Returns Promise<any>

login

Returns void

Object literals

Const Danbooru2Converter

artist

Parameters

data: any

Returns Artist

comment

Parameters

data: any

Returns Comment

note

Parameters

data: any

Returns Note

pool

Parameters

data: any

Returns Pool

post

Parameters

data: any

Returns Post

user

Parameters

data: any

Returns User

wiki

Parameters

data: any

Returns Wiki

Const Danbooru2UriBuilder

artist

Parameters

id: number

Returns string

artists

Parameters

query: Artists