Class ServiceCore

Class for represent a service core.

Hierarchy

ServiceCore

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServiceCore(config: ConfigType): ServiceCore

- Defined in src/classes/ServiceCore.ts:30
Constructor for the service core.

Parameters
- config: ConfigType
  
  Service core configuration.
Returns ServiceCore

Properties

config

config: ConfigType

Service core configuration.

plugins

plugins: typeof ServicePlugin[] = []

serviceTypes

serviceTypes: typeof Service[] = []

Methods

deserializeServiceObject

deserializeServiceObject(executionContext: ExecutionContext, serviceObject: ServiceType): Service

- Defined in src/classes/ServiceCore.ts:100
Parse a Javascript object to return a Service instance.

Parameters
- executionContext: ExecutionContext
  
  Execution context.
- serviceObject: ServiceType
  
  Javascript object of the service object.
Returns Service

New Service instance.

getService

getService(executionContext: ExecutionContext): Service | null

- Defined in src/classes/ServiceCore.ts:117
Return the service object in the users current directory.

Parameters
- executionContext: ExecutionContext
  
  Execution context.
Returns Service | null

New Service instance.

getServiceClassFromType

getServiceClassFromType(type: string): typeof Service | null

- Defined in src/classes/ServiceCore.ts:87
Returns the service class from its type.

Parameters
- type: string
  
  Service type name.
Returns typeof Service | null

The service class, or null if it doesn't exist.

Private refreshPlugins

refreshPlugins(): void

- Defined in src/classes/ServiceCore.ts:48
Refresh the plugins from the plugin names in the config.

function

refreshPlugins

memberof

ServiceCore

throws

{PluginNotFoundError}

Returns void

Private refreshServiceTypes

refreshServiceTypes(): void

- Defined in src/classes/ServiceCore.ts:75
Refresh the service types.

function

refreshServiceTypes

memberof

ServiceCore

Returns void

Generated using TypeDoc