@sora-soft/framework

---

@sora-soft/framework / Worker

Abstract Class: Worker

Defined in: packages/framework/src/lib/Worker.ts:21

Extended by

• Service
• SingletonWorker

Constructors

Constructor

new Worker(name, options): Worker;

Defined in: packages/framework/src/lib/Worker.ts:22

Parameters

Parameter	Type
name	string
options	IWorkerOptions

Returns

Worker

Properties

Property	Modifier	Type	Defined in
executor_	protected	Executor	packages/framework/src/lib/Worker.ts:207
intervalJobTimer_	protected	Timer	packages/framework/src/lib/Worker.ts:208
lifeCycle_	protected	LifeCycle<WorkerState>	packages/framework/src/lib/Worker.ts:206
options_	protected	IWorkerOptions	packages/framework/src/lib/Worker.ts:210
scope_	protected	WorkerScope	packages/framework/src/lib/Worker.ts:211
startTime_	protected	number	packages/framework/src/lib/Worker.ts:209

Accessors

executor

Get Signature

get executor(): Executor<Scope<unknown>>;

Defined in: packages/framework/src/lib/Worker.ts:187

Returns

Executor<Scope<unknown>>

---

id

Get Signature

get id(): string;

Defined in: packages/framework/src/lib/Worker.ts:183

Returns

string

---

isIdle

Get Signature

get isIdle(): boolean;

Defined in: packages/framework/src/lib/Worker.ts:171

Returns

boolean

---

lifeCycle

Get Signature

get lifeCycle(): LifeCycle<WorkerState>;

Defined in: packages/framework/src/lib/Worker.ts:179

Returns

LifeCycle<WorkerState>

---

metaData

Get Signature

get metaData(): IWorkerMetaData;

Defined in: packages/framework/src/lib/Worker.ts:195

Returns

IWorkerMetaData

---

name

Get Signature

get name(): string;

Defined in: packages/framework/src/lib/Worker.ts:163

Returns

string

---

scope

Get Signature

get scope(): WorkerScope;

Defined in: packages/framework/src/lib/Worker.ts:191

Returns

WorkerScope

---

state

Get Signature

get state(): WorkerState;

Defined in: packages/framework/src/lib/Worker.ts:167

Returns

WorkerState

---

stateSubject

Get Signature

get stateSubject(): BehaviorSubject<WorkerState>;

Defined in: packages/framework/src/lib/Worker.ts:175

Returns

BehaviorSubject<WorkerState>

Methods

connectComponent()

connectComponent(component): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:126

Parameters

Parameter	Type
component	Component

Returns

Promise<void>

---

connectComponents()

connectComponents(components): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:120

Parameters

Parameter	Type
components	Component[]

Returns

Promise<void>

---

disconnectComponent()

disconnectComponent(name): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:136

Parameters

Parameter	Type
name	string

Returns

Promise<void>

---

doJob()

protected doJob<T>(executor): Promise<T | undefined>;

Defined in: packages/framework/src/lib/Worker.ts:68

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
executor	JobExecutor<T>

Returns

Promise<T | undefined>

---

doJobInterval()

protected doJobInterval(executor, timeMS): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:72

Parameters

Parameter	Type
executor	JobExecutor
timeMS	number

Returns

Promise<void>

---

hasComponent()

hasComponent(id): boolean;

Defined in: packages/framework/src/lib/Worker.ts:153

Parameters

Parameter	Type
id	string

Returns

boolean

---

hasProvider()

hasProvider(id): boolean;

Defined in: packages/framework/src/lib/Worker.ts:149

Parameters

Parameter	Type
id	string

Returns

boolean

---

onError()

protected onError(err): void;

Defined in: packages/framework/src/lib/Worker.ts:157

Parameters

Parameter	Type
err	Error

Returns

void

---

registerProvider()

registerProvider(provider): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:98

Parameters

Parameter	Type
provider	Provider

Returns

Promise<void>

---

registerProviders()

registerProviders(providers): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:92

Parameters

Parameter	Type
providers	Provider<Route>[]

Returns

Promise<void>

---

runCommand()

runCommand(..._args): Promise<boolean>;

Defined in: packages/framework/src/lib/Worker.ts:64

Parameters

Parameter	Type
..._args	unknown[]

Returns

Promise<boolean>

---

shutdown()

abstract protected shutdown(reason): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:43

Parameters

Parameter	Type
reason	string

Returns

Promise<void>

---

start()

start(): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:34

Returns

Promise<void>

---

startup()

abstract protected startup(): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:33

Returns

Promise<void>

---

stop()

stop(reason): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:44

Parameters

Parameter	Type
reason	string

Returns

Promise<void>

---

unregisterProvider()

unregisterProvider(name): Promise<void>;

Defined in: packages/framework/src/lib/Worker.ts:108

Parameters

Parameter	Type
name	string

Returns

Promise<void>