@mcsb/framework / Exports / HypixelService

Class: HypixelService ​

Hierarchy ​

• Service

  ↳ HypixelService

Table of contents ​

Constructors ​

• constructor

Properties ​

• path

Methods ​

• addEndpoint
• addPlugin
• addService
• allEndpoints
• destroy
• getServices
• ownEndpoints
• searchForCircularStructure

Constructors ​

constructor ​

• new HypixelService(path, apiOptions)

Parameters ​

Overrides ​

Service.constructor

Defined in ​

bundled/hypixel/HypixelService.ts:8

Properties ​

path ​

• Readonly path: string

Inherited from ​

Service.path

Defined in ​

Service.ts:25

Methods ​

addEndpoint ​

▸ addEndpoint(path, endpoint): HypixelService

Parameters ​

Returns ​

HypixelService

Inherited from ​

Service.addEndpoint

Defined in ​

Service.ts:43

addPlugin ​

▸ addPlugin(plugin): HypixelService

Parameters ​

Returns ​

HypixelService

Inherited from ​

Service.addPlugin

Defined in ​

Service.ts:48

addService ​

▸ addService(service): HypixelService

Parameters ​

Returns ​

HypixelService

Inherited from ​

Service.addService

Defined in ​

Service.ts:34

allEndpoints ​

▸ allEndpoints(): Map<string, Endpoint>

Returns ​

Map<string, Endpoint>

Inherited from ​

Service.allEndpoints

Defined in ​

Service.ts:63

destroy ​

▸ destroy(): void

Returns ​

void

Overrides ​

Service.destroy

Defined in ​

bundled/hypixel/HypixelService.ts:17

getServices ​

▸ getServices(): Service[]

Returns ​

Service[]

Inherited from ​

Service.getServices

Defined in ​

Service.ts:79

ownEndpoints ​

▸ ownEndpoints(): Map<string, Endpoint>

Returns ​

Map<string, Endpoint>

Inherited from ​

Service.ownEndpoints

Defined in ​

Service.ts:55

searchForCircularStructure ​

▸ Protected searchForCircularStructure(visited?): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

Service.searchForCircularStructure

Defined in ​

Service.ts:89