@japofc/baileys - v2.4.7
    Preparing search index...

    Interface UsernameSocketMethods

    WhatsApp Username socket layer: check, set, pin, find, and recommend usernames. (Method list mirrors the makeWASocket return type in Socket/index.d.ts — keep both in sync.)

    interface UsernameSocketMethods {
        checkUsername: (
            username: string,
            includeSuggestions?: boolean,
        ) => Promise<CheckUsernameResult>;
        checkUsernameMulti: (usernames: string[]) => Promise<any>;
        deleteUsername: () => Promise<any>;
        fetchContactUsernames: (...jids: string[]) => Promise<any[]>;
        findUserByUsername: (
            username: string,
            pin?: string,
        ) => Promise<FoundUsernameUser | null>;
        getMyUsername: () => Promise<string | null>;
        getUsernameQueryIds: () => UsernameQueryIds;
        getUsernameRecommendations: (source?: string | null) => Promise<any>;
        refreshUsernameQueryIds: (
            options?: { dispatcher?: unknown; timeoutMs?: number },
        ) => Promise<{ isLatest: boolean; queryIds: UsernameQueryIds }>;
        reserveUsername: (
            username: string,
            options?: SetUsernameOptions,
        ) => Promise<any>;
        setUsername: (
            username: string,
            options?: SetUsernameOptions,
        ) => Promise<any>;
        setUsernamePin: (pin: string) => Promise<any>;
        setUsernameQueryIds: (patch: Partial<UsernameQueryIds>) => UsernameQueryIds;
    }
    Index
    checkUsername checkUsernameMulti deleteUsername fetchContactUsernames findUserByUsername getMyUsername getUsernameQueryIds getUsernameRecommendations refreshUsernameQueryIds reserveUsername setUsername setUsernamePin setUsernameQueryIds
    checkUsername: (
        username: string,
        includeSuggestions?: boolean,
    ) => Promise<CheckUsernameResult>

    Check username availability (with suggestions when taken).

    checkUsernameMulti: (usernames: string[]) => Promise<any>

    Check multiple usernames at once.

    deleteUsername: () => Promise<any>

    Delete / unset own username.

    fetchContactUsernames: (...jids: string[]) => Promise<any[]>

    Fetch usernames of known contacts (USync).

    findUserByUsername: (
        username: string,
        pin?: string,
    ) => Promise<FoundUsernameUser | null>

    Find a user by username (USync). Null when not found.

    getMyUsername: () => Promise<string | null>

    Get own username (null when unset).

    getUsernameQueryIds: () => UsernameQueryIds

    Snapshot the query_ids currently in effect.

    getUsernameRecommendations: (source?: string | null) => Promise<any>

    Get username recommendations.

    refreshUsernameQueryIds: (
        options?: { dispatcher?: unknown; timeoutMs?: number },
    ) => Promise<{ isLatest: boolean; queryIds: UsernameQueryIds }>

    Fetch the latest query_ids from the repo and apply them (manual pins preserved). Never throws.

    reserveUsername: (
        username: string,
        options?: SetUsernameOptions,
    ) => Promise<any>

    Reserve a username (WA 2026 reservation flow — same endpoint, reserved: true).

    setUsername: (username: string, options?: SetUsernameOptions) => Promise<any>

    Set own username.

    setUsernamePin: (pin: string) => Promise<any>

    Pin/unpin username (requires PIN).

    setUsernameQueryIds: (patch: Partial<UsernameQueryIds>) => UsernameQueryIds

    Hot-patch query_ids at runtime after WA rotates them (manual pins win over auto-rotation).

    Settings
    Member Visibility

    On This Page
    Properties