Class Playable

Implements Libp2p's Startable interface for easy reuse with async code.

Hierarchy (view full)

Playable

Implements

Startable

Index

Constructors

Properties

_isStarted _starting _stopping lifecycle

Methods

isStarted start stop

Constructors

constructor

new Playable(lifecycle): Playable
Parameters
- lifecycle: {
  starting(): Promise<void>;
  stopping(): Promise<void>;
  }
  - starting:function
    - starting(): Promise<void>
    - Returns Promise<void>
      Defined in utils/playable.ts:21
  - stopping:function
    - stopping(): Promise<void>
    - Returns Promise<void>
      Defined in utils/playable.ts:22
Returns Playable
- Defined in utils/playable.ts:19

Properties

`Private` _isStarted

_isStarted: boolean

`Private` _starting

_starting: null | Promise<void>

`Private` _stopping

_stopping: null | Promise<void>

`Private` `Readonly` lifecycle

lifecycle: {
starting(): Promise<void>;
stopping(): Promise<void>;
}

Type declaration

starting:function
- starting(): Promise<void>
- Returns Promise<void>
  - Defined in utils/playable.ts:21
stopping:function
- stopping(): Promise<void>
- Returns Promise<void>
  - Defined in utils/playable.ts:22

Methods

isStarted

isStarted(): boolean
Returns boolean
Implementation of Startable.isStarted
- Defined in utils/playable.ts:12

start

start(): Promise<void>
Returns Promise<void>
Implementation of Startable.start
- Defined in utils/playable.ts:30

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of Startable.stop
- Defined in utils/playable.ts:54

Generated using TypeDoc