Class DenoCommand<O>

Type Parameters

  • O extends IOPayload

Hierarchy

  • BaseShellCommand<O>
    • DenoCommand

Constructors

constructor

Properties

api config scriptPath stderr stdout

Methods

addListener execute listenerCount off on once prependListener prependOnceListener removeAllListeners removeListener spawn

Constructors

constructor

Properties

api

api: IShellServer

config

config: DenoRunConfig

scriptPath

scriptPath: string

Readonlystderr

stderr: EventEmitter<OutputEvents<O>> = ...

Event emitter for the stderr. Emits the data event.

Readonlystdout

stdout: EventEmitter<OutputEvents<O>> = ...

Event emitter for the stdout. Emits the data event.

Methods

addListener

  • addListener<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Alias for emitter.on(eventName, listener).

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

execute

listenerCount

  • listenerCount<N extends keyof CommandEvents>(eventName: N): number

  • Returns the number of listeners listening to the event named eventName.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N

    Returns number

    Since

    2.0.0

off

  • off<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Removes the all specified listener from the listener array for the event eventName Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

on

  • on<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

once

  • once<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

prependListener

  • prependListener<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

prependOnceListener

  • prependOnceListener<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

removeAllListeners

  • removeAllListeners<N extends keyof CommandEvents>(event?: N): this

  • Removes all listeners, or those of the specified eventName.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • Optionalevent: N

    Returns this

    Since

    2.0.0

removeListener

  • removeListener<N extends keyof CommandEvents>(
        eventName: N,
        listener: (arg: CommandEvents[N]) => void,
    ): this

  • Alias for emitter.off(eventName, listener).

    Type Parameters

    • N extends keyof CommandEvents

    Parameters

    • eventName: N
    • listener: (arg: CommandEvents[N]) => void

    Returns this

    Since

    2.0.0

spawn

Settings

Member Visibility

On This Page

Constructors
Properties
Methods