Interface Startable

Implemented by components that have a lifecycle

Hierarchy

Startable
- Libp2p

Index

Properties

afterStart? afterStop? beforeStart? beforeStop? isStarted start stop

Properties

`Optional` afterStart

afterStart?: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- If implemented, this method will be invoked after the start method.
  
  All other components will have had their start method invoked before this method is called.
  
  Returns void | Promise<void>

`Optional` afterStop

afterStop?: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- If implemented, this method will be invoked after the stop method.
  
  All other components will have had their stop method invoked before this method is called.
  
  Returns void | Promise<void>

`Optional` beforeStart

beforeStart?: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- If implemented, this method will be invoked before the start method.
  
  It should not assume any other components have been started.
  
  Returns void | Promise<void>

`Optional` beforeStop

beforeStop?: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- If implemented, this method will be invoked before the stop method.
  
  Any other components will still be running when this method is called.
  
  Returns void | Promise<void>

isStarted

isStarted: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

start

start: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- This method will be invoked to start the component.
  
  It should not assume that any other components have been started.
  
  Returns void | Promise<void>

stop

stop: (() => void | Promise<void>)

Type declaration

- (): void | Promise<void>
- This method will be invoked to stop the component.
  
  It should not assume any other components are running when it is called.
  
  Returns void | Promise<void>