Class RemoteGrobberClient

Remote version of a GrobberClient. Implements all the API functions GrobberClient does, but the work is performed by RemoteGrobberClientServer.

This client ought to be used by the content scripts in order to create a shared cache.

Hierarchy

RemoteGrobberClient

Implements

GrobberClientLike

Index

Constructors

constructor

Properties

Accessors

port

Methods

Constructors

constructor

new RemoteGrobberClient(portName?: string): RemoteGrobberClient

- Defined in grobber/remote.ts:50
Parameters
- Default value portName: string = "grobber"
Returns RemoteGrobberClient

Properties

Private Optional _port

_port: runtime.Port

Private portName

portName: string

Private waitingPromises

waitingPromises: object

Type declaration

[id: string]: Array<function>

Accessors

Private port

get port(): Port

- Defined in grobber/remote.ts:41
Returns Port

Methods

checkGrobberInfo

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

Implementation of GrobberClientLike.checkGrobberInfo
- Defined in grobber/remote.ts:63
Create a GrobberCheckReport for the Grobber server.

Parameters
- Optional baseURL: undefined | string
Returns Promise<GrobberCheckReport>

Private connect

connect(): void

- Defined in grobber/remote.ts:105
Returns void

getAnimeForTitle

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

Implementation of GrobberClientLike.getAnimeForTitle
- Defined in grobber/remote.ts:84
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>

Implementation of GrobberClientLike.getAnimeInfo
- Defined in grobber/remote.ts:68
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>

Implementation of GrobberClientLike.getEpisode
- Defined in grobber/remote.ts:73
Get an Episode.

throws

Same errors as GrobberClient.request

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

getGrobberInfo

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

Implementation of GrobberClientLike.getGrobberInfo
- Defined in grobber/remote.ts:58
Get the grobber information.

Parameters
- Optional baseURL: undefined | string
Returns Promise<GrobberInfo>

Private handleMessage

handleMessage(message: Message): void

- Defined in grobber/remote.ts:88
Parameters
- message: Message
Returns void

searchAnime

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

Implementation of GrobberClientLike.searchAnime
- Defined in grobber/remote.ts:78
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.

Private sendMessage

sendMessage(procedure: string, body: any): Promise<any>

- Defined in grobber/remote.ts:113
Parameters
- procedure: string
- body: any
Returns Promise<any>

Private waitForAnswer

waitForAnswer(id: string): Promise<MessageResponse>

- Defined in grobber/remote.ts:97
Parameters
- id: string
Returns Promise<MessageResponse>

Generated using TypeDoc