teleproto - v1.229.0
    Preparing search index...

    Interface QrCodeAuthParams

    interface QrCodeAuthParams {
        abortSignal?: AbortSignal;
        onError: (err: Error) => void | Promise<boolean>;
        password?: (hint?: string) => Promise<string>;
        qrCode?: (qrCode: { expires: number; token: Buffer }) => Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    abortSignal? onError password? qrCode?
    abortSignal?: AbortSignal

    an AbortSignal to cancel the QR login flow (e.g. the user closed the page).
    when aborted, the flow stops polling and rejects with an AbortError.

    onError: (err: Error) => void | Promise<boolean>

    when an error happens during auth this function will be called with the error.
    if this returns true the auth operation will stop.

    password?: (hint?: string) => Promise<string>

    optional string or callback that should return the 2FA password if present.
    the password hint will be sent in the hint param

    qrCode?: (qrCode: { expires: number; token: Buffer }) => Promise<void>

    a qrCode token for login through qrCode.
    this would need a QR code that you should scan with another app to login with.

    Settings
    Member Visibility

    On This Page
    Properties