Interface AmagiOptions

Hierarchy

  • AmagiOptions

Properties

cache defaultEngine ignoreDeadNode plugins request

Methods

modifyTracks

Properties

Optional cache

cache?: { enabled?: boolean; timeout?: number; type?: "storage" | "memory" }

Cache configuration

Type declaration

  • Optional enabled?: boolean

    Enable cache

  • Optional timeout?: number

    Cache timeout. -1 for infinity. Default to -1. (in second)

  • Optional type?: "storage" | "memory"

    Cache type. Default to memory

Optional defaultEngine

defaultEngine?: string

The default search engine

Optional ignoreDeadNode

ignoreDeadNode?: boolean

Ignore a dead node on init by not throwing an error. Default to false

Optional plugins

plugins?: any[]

Plugins

Optional request

request?: { retry?: number; timeout?: number }

Request configuration

Type declaration

  • Optional retry?: number

    Retry amount. Default to nodes length

  • Optional timeout?: number

    Request timeout. Default to 10000ms. (in ms)

Methods

Optional modifyTracks

  • modifyTracks(track: Track): any

  • If you want to modify track result to something else

    Parameters

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc