Interface Startable

A component that can be started and closed later.

interface Startable {
    started: boolean;
    close(options?): MaybePromise<void>;
    start(options?): MaybePromise<void>;
}

Hierarchy

Closeable
- Startable

Implemented by

Index

Properties

Methods

Properties

`Readonly` started

started: boolean

Returns if this has started.

Methods

close

close(options?): MaybePromise<void>
Closes this object and releases any system resource associated with it.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<void>
Inherited from Closeable.close
- Defined in packages/commons/src/lifecycle/closeable.ts:6

start

start(options?): MaybePromise<void>
Starts this component.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<void>
- Defined in packages/commons/src/lifecycle/startable.ts:10

Generated using TypeDoc