Class BooruSite`Abstract`

Hierarchy (View Summary)

BooruSite

Index

Constructors

Methods

autocomplete canSortRandomly getFileHosts getMaxTags getName getSlug getWebsite search

Constructors

constructor

new BooruSite(): BooruSite
Returns BooruSite

Methods

`Abstract`autocomplete

autocomplete(query: string): Promise<BooruAutoCompleteResult[]>
Get autocomplete suggestions for a given query.
Parameters
- query: string
  The partial tag query to get suggestions for.
Returns Promise<BooruAutoCompleteResult[]>
An array of autocomplete results.

`Abstract`canSortRandomly

canSortRandomly(): boolean
Check if the Booru site supports random sorting of posts.

Returns boolean
True if the Booru site supports random sorting, false otherwise.

`Abstract`getFileHosts

getFileHosts(): string[]
Get a list of file hosts used by the Booru site.

Returns string[]
An array of file host URLs.

getMaxTags

getMaxTags(): null | MaxTags
Get the maximum number of tags that can be used in a search query for unauthenticated and authenticated users.

Returns null | MaxTags
An object containing the maximum number of tags for unauthenticated and authenticated users, or null if there is no limit.

`Abstract`getName

getName(): string
Get the name of the Booru site.

Returns string
The name of the Booru site.

`Abstract`getSlug

getSlug(): string
Get the slug of the Booru site.

Returns string
The unique slug of the Booru site.

`Abstract`getWebsite

getWebsite(): string
Get the website URL of the Booru site.

Returns string
The website URL of the Booru site.

search

search(options: BooruSearchOptions): Promise<BooruPost[]>
Parameters
- options: BooruSearchOptions
Returns Promise<BooruPost[]>