Interface GrobberClientLike

Client which can interact with the Grobber API.

see: GrobberClient for the implementation.

Hierarchy

GrobberClientLike

Implemented by

Index

Methods

Methods

checkGrobberInfo

checkGrobberInfo(baseURL?: undefined | string): Promise<GrobberCheckReport>

- Defined in grobber/client.ts:132
Create a GrobberCheckReport for the Grobber server.

Parameters
- Optional baseURL: undefined | string
  
  Grobber url to get the GrobberInfo from.
Returns Promise<GrobberCheckReport>

getAnimeForTitle

getAnimeForTitle(title: string, group?: undefined | false | true): Promise<GrobberSearchResult<AnimeInfo> | undefined>

- Defined in grobber/client.ts:147
Get the Anime for a specific title.

Parameters
- title: string
- Optional group: undefined | false | true
Returns Promise<GrobberSearchResult<AnimeInfo> | undefined>
- Anime result, undefined if there was an error.

getAnimeInfo

getAnimeInfo(uid: string): Promise<AnimeInfo>

- Defined in grobber/client.ts:155
Get the Anime info for the given uid.

throws

Same errors as GrobberClient.request

Parameters
- uid: string
Returns Promise<AnimeInfo>

getEpisode

getEpisode(uid: string, episodeIndex: number): Promise<Episode>

- Defined in grobber/client.ts:164
Get an Episode.

throws

Same errors as GrobberClient.request

Parameters
- uid: string
- episodeIndex: number
  
  Index
Returns Promise<Episode>

getGrobberInfo

getGrobberInfo(baseURL?: undefined | string): Promise<GrobberInfo>

- Defined in grobber/client.ts:125
Get the grobber information.

Parameters
- Optional baseURL: undefined | string
  
  Grobber url to get the GrobberInfo from.
Returns Promise<GrobberInfo>

searchAnime

searchAnime(query: string, options?: GrobberSearchOptions): Promise<Array<GrobberSearchResult<GrobberMedium>> | undefined>

- Defined in grobber/client.ts:139
Search for Animes.

Parameters
- query: string
- Optional options: GrobberSearchOptions
Returns Promise<Array<GrobberSearchResult<GrobberMedium>> | undefined>
- List of search results, undefined` if there was an error.

Generated using TypeDoc