Skip to content

ppagent / InstanceBaseManager

Class: abstract InstanceBaseManager<InstanceType, CreatorType, CreateOptionsType, TParams>

Defined in: src/instance.base.manager.ts:26

Extended by

Type Parameters

InstanceType

InstanceType extends IInstance

CreatorType

CreatorType extends (...args) => any

CreateOptionsType

CreateOptionsType extends IInstanceCreateOptions

TParams

TParams extends IConfigParams

Constructors

Constructor

new InstanceBaseManager<InstanceType, CreatorType, CreateOptionsType, TParams>(options?): InstanceBaseManager<InstanceType, CreatorType, CreateOptionsType, TParams>

Defined in: src/instance.base.manager.ts:31

Parameters

options?

IInstanceBaseMangerOptions

Returns

InstanceBaseManager<InstanceType, CreatorType, CreateOptionsType, TParams>

Methods

clearInstances()

clearInstances(): Promise<void>

Defined in: src/instance.base.manager.ts:112

Returns

Promise<void>


createInstance()

createInstance(name, options): InstanceType

Defined in: src/instance.base.manager.ts:91

创建实例

Parameters

name

string

options

CreateOptionsType

Returns

InstanceType


getAllParams()

getAllParams(): object

Defined in: src/instance.base.manager.ts:57

Returns

object


getAllParamsArray()

getAllParamsArray(): TParams[]

Defined in: src/instance.base.manager.ts:61

Returns

TParams[]


getInstance()

getInstance(instanceName): InstanceType

Defined in: src/instance.base.manager.ts:70

只有允许缓存实例的管理器才能够获取到创建过的实例

Parameters

instanceName

string

Returns

InstanceType


getInstances()

getInstances(typeName?): InstanceType[]

Defined in: src/instance.base.manager.ts:78

获取某个类型的所有的实例

Parameters

typeName?

string

类型名称

Returns

InstanceType[]


getParams()

getParams(name): TParams

Defined in: src/instance.base.manager.ts:53

根据固有名称获取其相关参数

Parameters

name

string

Returns

TParams


registerInstanceCreator()

registerInstanceCreator(creator, params): void

Defined in: src/instance.base.manager.ts:41

消息源创建器注册。一般由插件进行注册。

Parameters

creator

CreatorType

params

TParams

Returns

void