mpc-js
    Preparing search index...

    Interface MPDProtocol

    Implements the general syntax of the Music Player Daemon protocol

    interface MPDProtocol {
        mpdVersion?: [number, number, number];
        get isReady(): boolean;
        addListener<T extends string | symbol>(
            event: T,
            fn: (...args: any[]) => void,
            context?: any,
        ): this;
        disconnect(err?: { errorCode: number; errorMessage: string }): void;
        emit<T extends string | symbol>(event: T, ...args: any[]): boolean;
        eventNames(): (string | symbol)[];
        listenerCount(event: string | symbol): number;
        listeners<T extends string | symbol>(
            event: T,
        ): ((...args: any[]) => void)[];
        off<T extends string | symbol>(
            event: T,
            fn?: (...args: any[]) => void,
            context?: any,
            once?: boolean,
        ): this;
        on<T extends string | symbol>(
            event: T,
            fn: (...args: any[]) => void,
            context?: any,
        ): this;
        once<T extends string | symbol>(
            event: T,
            fn: (...args: any[]) => void,
            context?: any,
        ): this;
        parse<T>(
            lines: string[],
            markers: string[],
            convert: (valueMap: Map<string, string>) => T,
        ): T[];
        parseGrouped<T>(
            lines: string[],
            groupingTag: undefined | string,
        ): Map<string, string[]>;
        removeAllListeners(event?: string | symbol): this;
        removeListener<T extends string | symbol>(
            event: T,
            fn?: (...args: any[]) => void,
            context?: any,
            once?: boolean,
        ): this;
        sendCommand(cmd: string): Promise<MPDResponse>;
    }

    Hierarchy

    • EventEmitter
      • MPDProtocol
    Index

    Properties

    mpdVersion?

    Accessors

    isReady

    Methods

    addListener disconnect emit eventNames listenerCount listeners off on once parse parseGrouped removeAllListeners removeListener sendCommand

    Properties

    mpdVersion?: [number, number, number]

    The version (major, minor, patch) of the connected daemon

    Accessors

    Methods

    • Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: (...args: any[]) => void
      • Optionalcontext: any

      Returns this

    • Disconnect from the daemon

      Parameters

      • err: { errorCode: number; errorMessage: string } = ...

      Returns void

    • Calls each of the listeners registered for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • ...args: any[]

      Returns boolean

    • Return an array listing the events for which the emitter has registered listeners.

      Returns (string | symbol)[]

    • Return the number of listeners listening to a given event.

      Parameters

      • event: string | symbol

      Returns number

    • Return the listeners registered for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T

      Returns ((...args: any[]) => void)[]

    • Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Optionalfn: (...args: any[]) => void
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    • Add a listener for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: (...args: any[]) => void
      • Optionalcontext: any

      Returns this

    • Add a one-time listener for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: (...args: any[]) => void
      • Optionalcontext: any

      Returns this

    • Helper function for parsing a response from the daemon into an array of objects

      Type Parameters

      • T

      Parameters

      • lines: string[]

        The daemon response

      • markers: string[]

        Markers are keys denoting the start of a new object within the response

      • convert: (valueMap: Map<string, string>) => T

        Converts a key-value Map from the response into the desired target object

      Returns T[]

    • Type Parameters

      • T

      Parameters

      • lines: string[]
      • groupingTag: undefined | string

      Returns Map<string, string[]>

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optionalevent: string | symbol

      Returns this

    • Remove the listeners of a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Optionalfn: (...args: any[]) => void
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    • Send a command to the daemon. The returned promise will be resolved with an array containing the lines of the daemon's response.

      Parameters

      • cmd: string

      Returns Promise<MPDResponse>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods