Class Hub

Index

Constructors

Methods

add budgetFor byCredential get has list

Constructors

constructor

new Hub(options?: HubOptions): Hub
Parameters
- options: HubOptions = {}
Returns Hub
- Defined in core/src/client/hub.ts:32

Methods

add

add(name: string, plane: Plane): this
Parameters
- name: string
- plane: Plane
Returns this
- Defined in core/src/client/hub.ts:41

budgetFor

budgetFor(credentialKey: string): Budget
the governor this credential spends against, shared with every plane using the same one
Parameters
- credentialKey: string
Returns Budget
- Defined in core/src/client/hub.ts:37

byCredential

byCredential(): Map<string, HubEntry[]>
planes grouped by the credential they spend, which is what a budget actually covers

Returns Map<string, HubEntry[]>
- Defined in core/src/client/hub.ts:69

get

get(name: string): Plane
Parameters
- name: string
Returns Plane
- Defined in core/src/client/hub.ts:49

has

has(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in core/src/client/hub.ts:60

list

list(): HubEntry[]
Returns HubEntry[]
- Defined in core/src/client/hub.ts:64