andesitejs / Exports / api/node/REST / REST

Class: REST

api/node/REST.REST

Hierarchy

• EventEmitter

  ↳ REST

Table of contents

Constructors

• constructor

Properties

• node
• requests

Accessors

• baseUrl

Methods

• decodeTracks
• emit
• getStats
• loadTracks
• make

Constructors

constructor

+ new REST(node: Node): REST

Parameters:

Name	Type	Description
node	Node	The node this rest manager belongs to.

Returns: REST

Defined in: api/node/REST.ts:16

Properties

node

• Readonly node: Node

The node instance.

Defined in: api/node/REST.ts:11

---

requests

• requests: { failed: number ; successful: number }

Request analytics.

Type declaration:

Name	Type
failed	number
successful	number

Defined in: api/node/REST.ts:16

Accessors

baseUrl

• baseUrl(): string

The base url for all requests.

Returns: string

Defined in: api/node/REST.ts:34

Methods

decodeTracks

▸ decodeTracks(track: string): Promise<TrackInfo>

Returns metadata for the provided track.

Parameters:

Name	Type	Description
track	string	The track to decode.

Returns: Promise<TrackInfo>

Defined in: api/node/REST.ts:58

▸ decodeTracks(track: string[]): Promise<TrackInfo[]>

Returns metadata for the provided tracks.

Parameters:

Name	Type	Description
track	string[]	The tracks to decode.

Returns: Promise<TrackInfo[]>

Defined in: api/node/REST.ts:65

---

emit

▸ emit(event: string, ...args: any[]): boolean

Parameters:

Name	Type	Description
event	string
...args	any[]

Returns: boolean

Defined in: api/node/REST.ts:81

---

getStats

▸ getStats(): Promise<NodeStats>

Returns stats about the andesite instance.

Returns: Promise<NodeStats>

Defined in: api/node/REST.ts:41

---

loadTracks

▸ loadTracks(identifier: string): Promise<LoadTracksResponse>

Loads tracks with the provided identifier..

Parameters:

Name	Type	Description
identifier	string	The search identifier.

Returns: Promise<LoadTracksResponse>

Defined in: api/node/REST.ts:49

---

make

▸ make<T>(endpoint: string, options?: RequestOptions): Promise<T>

Makes a request to the andesite instance.

Type parameters:

Name
T

Parameters:

Name	Type	Default value	Description
endpoint	string	-	The endpoint to make a request to.
options	RequestOptions	...	Additional request options

Returns: Promise<T>

Defined in: api/node/REST.ts:95