@mcsb/framework / Exports / Starboard

Class: Starboard ​

Hierarchy ​

• Service

  ↳ Starboard

Table of contents ​

Constructors ​

• constructor

Properties ​

• path

Methods ​

• addEndpoint
• addPlugin
• addService
• allEndpoints
• destroy
• getHostname
• getPort
• getServer
• getServices
• isRunning
• ownEndpoints
• searchForCircularStructure
• start
• stop

Constructors ​

constructor ​

• new Starboard(options?)

Parameters ​

Overrides ​

Service.constructor

Defined in ​

Starboard.ts:10

Properties ​

path ​

• Readonly path: string

Inherited from ​

Service.path

Defined in ​

Service.ts:25

Methods ​

addEndpoint ​

▸ addEndpoint(path, endpoint): Starboard

Parameters ​

Returns ​

Starboard

Inherited from ​

Service.addEndpoint

Defined in ​

Service.ts:43

addPlugin ​

▸ addPlugin(plugin): Starboard

Parameters ​

Returns ​

Starboard

Inherited from ​

Service.addPlugin

Defined in ​

Service.ts:48

addService ​

▸ addService(service): Starboard

Parameters ​

Returns ​

Starboard

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

Inherited from ​

Service.destroy

Defined in ​

Service.ts:83

getHostname ​

▸ getHostname(): string

Returns ​

string

Defined in ​

Starboard.ts:66

getPort ​

▸ getPort(): number

Returns ​

number

Defined in ​

Starboard.ts:58

getServer ​

▸ getServer(): undefined | Server<typeof IncomingMessage, typeof ServerResponse>

Returns ​

undefined | Server<typeof IncomingMessage, typeof ServerResponse>

Defined in ​

Starboard.ts:40

getServices ​

▸ getServices(): Service[]

Returns ​

Service[]

Inherited from ​

Service.getServices

Defined in ​

Service.ts:79

isRunning ​

▸ isRunning(): boolean

Returns ​

boolean

Defined in ​

Starboard.ts:36

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

start ​

▸ start(): Promise<void>

Returns ​

Promise<void>

Defined in ​

Starboard.ts:15

stop ​

▸ stop(): Promise<void>

Returns ​

Promise<void>

Defined in ​

Starboard.ts:44