@sora-soft/framework

---

@sora-soft/framework / Component

Abstract Class: Component

Defined in: packages/framework/src/lib/Component.ts:15

Constructors

Constructor

new Component(): Component;

Defined in: packages/framework/src/lib/Component.ts:16

Returns

Component

Properties

Property	Modifier	Type	Defined in
id_	protected	string	packages/framework/src/lib/Component.ts:98
name_	protected	string	packages/framework/src/lib/Component.ts:99
options_	protected	IComponentOptions	packages/framework/src/lib/Component.ts:100
ref_	protected	LifeRef<void>	packages/framework/src/lib/Component.ts:101

Accessors

id

Get Signature

get id(): string;

Defined in: packages/framework/src/lib/Component.ts:65

Returns

string

---

meta

Get Signature

get meta(): IComponentMetaData;

Defined in: packages/framework/src/lib/Component.ts:85

Returns

IComponentMetaData

---

name

Get Signature

get name(): string;

Defined in: packages/framework/src/lib/Component.ts:69

Returns

string

Set Signature

set name(value): void;

Defined in: packages/framework/src/lib/Component.ts:73

Parameters

Parameter	Type
value	string

Returns

void

---

options

Get Signature

get options(): IComponentOptions;

Defined in: packages/framework/src/lib/Component.ts:81

Returns

IComponentOptions

---

ready

Get Signature

get ready(): boolean;

Defined in: packages/framework/src/lib/Component.ts:77

Returns

boolean

---

scope

Get Signature

get scope(): ComponentScope;

Defined in: packages/framework/src/lib/Component.ts:94

Returns

ComponentScope

---

version

Get Signature

get abstract version(): string;

Defined in: packages/framework/src/lib/Component.ts:63

Returns

string

Methods

connect()

abstract protected connect(): Promise<void>;

Defined in: packages/framework/src/lib/Component.ts:31

Returns

Promise<void>

---

disconnect()

abstract protected disconnect(): Promise<void>;

Defined in: packages/framework/src/lib/Component.ts:46

Returns

Promise<void>

---

loadOptions()

loadOptions(options): void;

Defined in: packages/framework/src/lib/Component.ts:26

Parameters

Parameter	Type
options	IComponentOptions

Returns

void

---

setOptions()

abstract protected setOptions(options): void;

Defined in: packages/framework/src/lib/Component.ts:25

Parameters

Parameter	Type
options	IComponentOptions

Returns

void

---

start()

start(): Promise<void>;

Defined in: packages/framework/src/lib/Component.ts:32

Returns

Promise<void>

---

stop()

stop(): Promise<void>;

Defined in: packages/framework/src/lib/Component.ts:47

Returns

Promise<void>