@dvxch/yandex-music
    Preparing search index...

    Interface DeviceAuthOptions

    Options for the blocking device flow (see deviceAuth).

    interface DeviceAuthOptions {
        clientId?: string;
        clientSecret?: string;
        deviceId?: string;
        deviceName?: string;
        pollInterval?: number;
        shouldCancel?: () => boolean;
        timeout?: number;
    }
    Index

    Properties

    clientId? clientSecret? deviceId? deviceName? pollInterval? shouldCancel? timeout?

    Properties

    clientId?: string

    OAuth client id. Defaults to the Android app's id.

    clientSecret?: string

    OAuth client secret. Defaults to the Android app's secret.

    deviceId?: string

    Device id. Defaults to a random 10-character string.

    deviceName?: string

    Human-readable device name. Defaults to YandexMusicAPI.

    pollInterval?: number

    Override the polling interval in seconds (defaults to the server's hint).

    shouldCancel?: () => boolean

    Return true to abort polling early.

    timeout?: number

    Overall timeout in seconds (defaults to the code's lifetime).

    Settings

    Member Visibility

    On This Page

    Properties