Class default

CleanerAPI implements the API used by the cleaner worker.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

cleanup watchCleanups

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/cleaner/CleanerV2.ts:44

Properties

NAME

NAME: string = "Cleaner"

VERSION

VERSION: number = 2

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Cleaner"

`Static` VERSION

VERSION: number = 2

Methods

cleanup

cleanup(params: any): Promise<any>
Cleanup triggers a state cleanup
Parameters
- params: any
Returns Promise<any>
- Defined in api/facades/cleaner/CleanerV2.ts:54

watchCleanups

watchCleanups(params: any): Promise<NotifyWatchResult>
WatchCleanups watches for cleanups to be performed in state.
Parameters
- params: any
Returns Promise<NotifyWatchResult>
- Defined in api/facades/cleaner/CleanerV2.ts:70

Generated using TypeDoc