Options
All
  • Public
  • Public/Protected
  • All
Menu

Module grobber

Client library for interacting with the Grobber API. Next to the GrobberClient this module also exposes some specialised classes.

RemoteGrobberClient uses extension messages to perform the workload in RemoteGrobberClientServer which should be running in the background. This allows for some powerful caching which otherwise wouldn't be possible.

For GrobberClient and RemoteGrobberClient there are exported "static" instances grobberClient and remoteGrobberClient respectively.

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const grobberClient

grobberClient: GrobberClient = new GrobberClient()

Default GrobberClient.

Const remoteGrobberClient

remoteGrobberClient: RemoteGrobberClient = new RemoteGrobberClient()

Default RemoteGrobberClient.

Let responseCacheTTL

responseCacheTTL: number = 1000 * 60 * 60

Time-to-live for cached GrobberClient objects. Defaults to an hour.

Functions

animeFromResp

buildKeys

  • buildKeys(params: Array<[any, any]>): [string[], string]

  • Create lock keys and the memory key from the parameters.

    Parameters

    • params: Array<[any, any]>

    Returns [string[], string]

createExpiringItem

  • createExpiringItem<T>(item: T, expireAt: number): ExpiringItem<T>

createMessage

  • createMessage(procedure: string, body: any): Message

episodeFromResp

  • episodeFromResp(resp: any): Episode

grobberMediumFromRespData

streamFromResponse

Generated using TypeDoc