Class RoboSetupListener

Listens for a robo host's setup-progress updates and re-emits the ones belonging to this organisation.

Updates are advisory and can be missed — see RoboSetupUpdate. No sequence of them means a host is ready; RoboHost.waitUntilOnline answers that.

Obtain one via RoboHost.listenToSetup or Salt.listenToRoboSetup.

Example

const setup = await host.listenToSetup();
setup.on('setupUpdate', ({ step, description }) => {
  console.log(`${step}: ${description}`);
});

const online = await host.waitUntilOnline();
setup.disableSetupListener();

Hierarchy

EventEmitter<RoboSetupListenerEvents>
- RoboSetupListener

Index

Properties

prefixed

Methods

addListener disableSetupListener emit enableSetupListener eventNames listenerCount listeners off on once removeAllListeners removeListener

Properties

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends keyof RoboSetupListenerEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
          T,
          keyof RoboSetupListenerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener

disableSetupListener

disableSetupListener(): void
Stop listening for setup updates. Unsubscribes without closing the underlying websocket — call Salt.disconnect to close the socket and allow the Node.js process to exit.

Returns void
Example
```
setup.disableSetupListener();
```

emit

emit<T extends keyof RoboSetupListenerEvents>(
    event: T,
    ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
        T,
        keyof RoboSetupListenerEvents,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
- ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<T, keyof RoboSetupListenerEvents>]
Returns boolean
Inherited from EventEmitter.emit

enableSetupListener

enableSetupListener(): void
Subscribes to setup updates on the underlying socket. Called by RoboHost.listenToSetup and Salt.listenToRoboSetup after construction; you only need to call it again after a matching disableSetupListener to resume listening. Idempotent — calling while already enabled is a no-op.

Returns void
Example
```
setup.enableSetupListener();
```

eventNames

eventNames(): (keyof RoboSetupListenerEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof RoboSetupListenerEvents)[]
Inherited from EventEmitter.eventNames

listenerCount

listenerCount(event: keyof RoboSetupListenerEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof RoboSetupListenerEvents
Returns number
Inherited from EventEmitter.listenerCount

listeners

listeners<T extends keyof RoboSetupListenerEvents>(
    event: T,
): (
    (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void
)[]
Inherited from EventEmitter.listeners

off

off<T extends keyof RoboSetupListenerEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
          T,
          keyof RoboSetupListenerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off

on

on<T extends keyof RoboSetupListenerEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
          T,
          keyof RoboSetupListenerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on

once

once<T extends keyof RoboSetupListenerEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
          T,
          keyof RoboSetupListenerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once

removeAllListeners

removeAllListeners(event?: keyof RoboSetupListenerEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof RoboSetupListenerEvents
Returns this
Inherited from EventEmitter.removeAllListeners

removeListener

removeListener<T extends keyof RoboSetupListenerEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
            T,
            keyof RoboSetupListenerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof RoboSetupListenerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
          T,
          keyof RoboSetupListenerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener

Class RoboSetupListener

Example

Hierarchy

Index

Properties

Methods

Properties

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

disableSetupListener

Returns void

Example

emit

Type Parameters

Parameters

Returns boolean

enableSetupListener

Returns void

Example

eventNames

Returns (keyof RoboSetupListenerEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<RoboSetupListenerEvents>[Extract< T, keyof RoboSetupListenerEvents, >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Settings

On This Page

`Static`prefixed

Returns (
(
...args: ArgumentMap<RoboSetupListenerEvents>[Extract<
T,
keyof RoboSetupListenerEvents,
>],
) => void
)[]