Interface Space

Hierarchy

Space

Implemented by

Index

Properties

Methods

Properties

Readonly isRunning

isRunning: boolean

Returns true if this space is running.

Readonly stdout

stdout: Readable

Methods

on

on(type: "message", messageListener: MessageListener): this
on(type: "error", errorListener: ErrorListener): this
on(type: "rejection", rejectionListener: RejectionListener): this

- Defined in index.ts:47
The message event is emitted when the program inside this space sends a message via process.send().

The error event is emitted when the program inside this space throws an Error.

The rejection event is emitted when the program inside this space occurs an unhandled promise rejection.

Parameters
- type: "message"
- messageListener: MessageListener
Returns this
- Defined in index.ts:49
Parameters
- type: "error"
- errorListener: ErrorListener
Returns this
- Defined in index.ts:51
Parameters
- type: "rejection"
- rejectionListener: RejectionListener
Returns this

send

send(message: unknown): void

- Defined in index.ts:23
Sends a message to the program inside this space.

Parameters
- message: unknown
  
  Any type of value can be sent. In the some space types, the message is restricted by JSON.stringify; recursive data and non-JSON-serializable values cannot to be sent.
Returns void

stop

stop(): Promise<void>

- Defined in index.ts:33
Stops this space.

Returns Promise<void>

waitMessage

waitMessage(predicate: WaitMessagePredicate): Promise<void>

- Defined in index.ts:28
Returns a promise object that resolves when the given predicate returns true.

Parameters
- predicate: WaitMessagePredicate
Returns Promise<void>

waitStart

waitStart(): Promise<void>

- Defined in index.ts:17
Waits for that the worker has started.

Returns Promise<void>

waitStop

waitStop(): Promise<void>

- Defined in index.ts:38
Waits for that the program inside this space stops.

Returns Promise<void>

Generated using TypeDoc