Class LavasfyClient

Hierarchy

LavasfyClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LavasfyClient(options: ClientOptions, nodesOpt: NodeOptions[]): LavasfyClient

- Defined in Client.ts:19
Parameters
- options: ClientOptions
- nodesOpt: NodeOptions[]
Returns LavasfyClient

Properties

Readonly baseURL

baseURL: string

Spotify API base URL

Private Optional nextRequest

nextRequest: Timeout

nodes

nodes: Map<string, Node> = ...

The Nodes are stored here

options

options: Readonly<ClientOptions>

The provided options when the class was instantiated

Readonly spotifyPattern

spotifyPattern: RegExp

A RegExp that will be used for validate and parse URLs

Readonly token

token: null | string

The token to access the Spotify API

Methods

addNode

addNode(options: NodeOptions): void

- Defined in Client.ts:38
Parameters
- options: NodeOptions
Returns void

getNode

getNode(): Node
getNode(id: string): undefined | Node

- Defined in Client.ts:52
Returns Node
- Defined in Client.ts:53
Parameters
- id: string
Returns undefined | Node

isValidURL

isValidURL(url: string): boolean

- Defined in Client.ts:63
Determine the URL is a valid Spotify URL or not

Parameters
- url: string
Returns boolean

removeNode

removeNode(id: string): boolean

- Defined in Client.ts:42
Parameters
- id: string
Returns boolean

requestToken

requestToken(): Promise<void>

- Defined in Client.ts:68
A method to retrieve the Spotify API token. (this method only needs to be invoked once after the LavasfyClient instantiated)

Returns Promise<void>

Generated using TypeDoc