Class ServiceManager

The Service Manager controls the lifecycle of all Services in an App

Hierarchy

AdvancedManager<string, Service>
- ServiceManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ServiceManager(app: IApp): ServiceManager

Overrides AdvancedManager.constructor
- Defined in packages/native/src/service.ts:31
Register App details

Parameters
- app: IApp
Returns ServiceManager

Properties

app

app: IApp

The App the AdvancedManager is attached to

config

config: ICONFIG

The Config of the App the AdvancedManager is attached to

emitter

emitter: EventEmitter

The EventEmitter of the App the AdvancedManager is attached to

map

map: Map<string, Service>

For backward compatability and performance reasons Manager use Map to store data

Accessors

length

get length(): number

- Defined in packages/manager/src/api.ts:55
An alias for size

Returns number

size

get size(): number

- Defined in packages/manager/src/api.ts:50
Returns the total number of items stored in the Manager

Returns number

Methods

[iterator]

[iterator](): IterableIterator<[string, Service]>

Inherited from AdvancedManager.[iterator]
- Defined in packages/manager/src/api.ts:102
Allows for iteration via for..of, learn more: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators]

Returns IterableIterator<[string, Service]>

add

add(value: Service): Manager<string, Service>

Inherited from AdvancedManager.add
- Defined in packages/manager/src/api.ts:41
Adds a value to Manager, and uses the current size of the Manager as it's key, it works best when all the key in the Manager are numbers

Parameters
- value: Service
Returns Manager<string, Service>

boot

boot(): ServiceManager

- Defined in packages/native/src/service.ts:42
Call the boot method for all Services

Returns ServiceManager

clear

clear(): Manager<string, Service>

Inherited from AdvancedManager.clear
- Defined in packages/manager/src/api.ts:77
Clear the Manager of all its contents

Returns Manager<string, Service>

delete

delete(key: string): boolean

Inherited from AdvancedManager.delete
- Defined in packages/manager/src/api.ts:66
Removes a value stored in the Manager via a key, returns true if an element in the Map object existed and has been removed, or false if the element does not exist

Parameters
- key: string
Returns boolean

entries

entries(): IterableIterator<[string, Service]>

Inherited from AdvancedManager.entries
- Defined in packages/manager/src/api.ts:88
Returns a new Iterator object that contains an array of [key, value] for each element in the Map object in insertion order.

Returns IterableIterator<[string, Service]>

forEach

forEach(callback: (value?: Service, key?: string, map?: Map<string, Service>) => void, context?: object): Manager<string, Service>

Inherited from AdvancedManager.forEach
- Defined in packages/manager/src/api.ts:93
Iterates through the Managers contents, calling a callback function every iteration

Parameters
- callback: (value?: Service, key?: string, map?: Map<string, Service>) => void
  - - (value?: Service, key?: string, map?: Map<string, Service>): void
    - Parameters
      - Optional value: Service
      - Optional key: string
      - Optional map: Map<string, Service>
      Returns void
- Optional context: object
Returns Manager<string, Service>

get

get(key: string): Service

Inherited from AdvancedManager.get
- Defined in packages/manager/src/api.ts:20
Get a value stored in the Manager

Parameters
- key: string
Returns Service

getMap

getMap(): Map<string, Service>

Inherited from AdvancedManager.getMap
- Defined in packages/manager/src/api.ts:15
Returns the Manager classes base Map

Returns Map<string, Service>

has

has(key: string): boolean

Inherited from AdvancedManager.has
- Defined in packages/manager/src/api.ts:83
Checks if the Manager contains a certain key

Parameters
- key: string
Returns boolean

init

init(): ServiceManager

- Defined in packages/native/src/service.ts:36
Call the init method for all Services

Returns ServiceManager

keys

keys(): string[]

Inherited from AdvancedManager.keys
- Defined in packages/manager/src/api.ts:25
Returns the keys of all items stored in the Manager as an Array

Returns string[]

last

last(distance?: number): Service

Inherited from AdvancedManager.last
- Defined in packages/manager/src/api.ts:60
Returns the last item in the Manager who's index is a certain distance from the last item in the Manager

Parameters
- distance: number = 1
Returns Service

remove

remove(key: string): Manager<string, Service>

Inherited from AdvancedManager.remove
- Defined in packages/manager/src/api.ts:71
Removes a value stored in the Manager via a key, returns the Manager class, allowing for chains

Parameters
- key: string
Returns Manager<string, Service>

set

set(key: string, value: Service): ServiceManager

Inherited from AdvancedManager.set
- Defined in packages/native/src/manager.ts:78
Add a ManagerItem to AdvancedManager at a specified key

Parameters
- key: string
- value: Service
Returns ServiceManager

stop

stop(): ServiceManager

- Defined in packages/native/src/service.ts:48
Call the stop method for all Services

Returns ServiceManager

values

values(): Service[]

Inherited from AdvancedManager.values
- Defined in packages/manager/src/api.ts:30
Returns the values of all items stored in the Manager as an Array

Returns Service[]

Generated using TypeDoc