Class Runtime

Provides access to runtime data of a Coaty container, including common configuration options, as well as platform and framework meta information.

Hierarchy

Runtime

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Runtime(_commonOptions: CommonOptions, _databaseOptions: DatabaseOptions): Runtime

- Defined in src/runtime/runtime.ts:89
internal
- For internal use in framework only.
Parameters
- _commonOptions: CommonOptions
- _databaseOptions: DatabaseOptions
Returns Runtime

Accessors

commonOptions

get commonOptions(): Readonly<CommonOptions>

- Defined in src/runtime/runtime.ts:18
Gets common options specified in container configuration (optional).

Returns Readonly<CommonOptions>

databaseOptions

get databaseOptions(): Readonly<DatabaseOptions>

- Defined in src/runtime/runtime.ts:25
Gets database options specified in container configuration (optional).

Returns Readonly<DatabaseOptions>

frameworkBuildDate

get frameworkBuildDate(): Date

- Defined in src/runtime/runtime.ts:69
Gets the framework's build date.

Returns Date

frameworkName

get frameworkName(): string

- Defined in src/runtime/runtime.ts:55
Gets the framework's package name.

Returns string

frameworkVersion

get frameworkVersion(): string

- Defined in src/runtime/runtime.ts:62
Gets the framework package version.

Returns string

isCommonJsPlatform

get isCommonJsPlatform(): boolean

- Defined in src/runtime/runtime.ts:33
Determines whether container is running on a CommonJS platform (such as Node.js).

Returns boolean

isWebPlatform

get isWebPlatform(): boolean

- Defined in src/runtime/runtime.ts:41
Determines whether container is running in a web browser (excluding web worker).

Returns boolean

isWebWorkerPlatform

get isWebWorkerPlatform(): boolean

- Defined in src/runtime/runtime.ts:48
Determines whether container is running inside a web worker.

Returns boolean

Methods

newUuid

newUuid(): string

- Defined in src/runtime/runtime.ts:107
Returns a newly generated UUID v4.

Returns string

Static newUuid

newUuid(): string

- Defined in src/runtime/runtime.ts:100
Returns a newly generated UUID v4.

Returns string

Generated using TypeDoc