@adiwajshing/baileys-md

Binary

aesDecrypt

• aesDecrypt(buffer: Buffer, key: Buffer): Buffer

• decrypt AES 256 CBC; where the IV is prefixed to the buffer

  Parameters

  • buffer: Buffer

  • key: Buffer

  Returns Buffer

aesDecryptWithIV

• aesDecryptWithIV(buffer: Buffer, key: Buffer, IV: Buffer): Buffer

• decrypt AES 256 CBC

  Parameters

  • buffer: Buffer

  • key: Buffer

  • IV: Buffer

  Returns Buffer

aesEncrypWithIV

• aesEncrypWithIV(buffer: Buffer, key: Buffer, IV: Buffer): Buffer

• Parameters

  • buffer: Buffer

  • key: Buffer

  • IV: Buffer

  Returns Buffer

aesEncrypt

• aesEncrypt(buffer: Buffer | Uint8Array, key: Buffer): Buffer

• Parameters

  • buffer: Buffer | Uint8Array

  • key: Buffer

  Returns Buffer

Const areJidsSameUser

• areJidsSameUser(jid1: string, jid2: string): boolean

• is the jid a user

  Parameters

  • jid1: string

  • jid2: string

  Returns boolean

Const assertNodeErrorFree

• assertNodeErrorFree(node: BinaryNode): void

• Parameters

  • node: BinaryNode

  Returns void

Const chatModificationToAppPatch

• chatModificationToAppPatch(mod: ChatModification, jid: string, lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]): WAPatchCreate

• Parameters

  • mod: ChatModification

  • jid: string

  • lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]

  Returns WAPatchCreate

Const compressImage

• compressImage(bufferOrFilePath: string | Buffer | Readable): Promise<Buffer>

• Parameters

  • bufferOrFilePath: string | Buffer | Readable

  Returns Promise<Buffer>

Const configureSuccessfulPairing

• configureSuccessfulPairing(stanza: BinaryNode, __namedParameters: Pick<AuthenticationCreds, "signedIdentityKey" | "advSecretKey" | "signalIdentities">): { creds: Partial<AuthenticationCreds>; reply: BinaryNode }

• Parameters

  • stanza: BinaryNode

  • __namedParameters: Pick<AuthenticationCreds, "signedIdentityKey" | "advSecretKey" | "signalIdentities">

  Returns { creds: Partial<AuthenticationCreds>; reply: BinaryNode }

  • creds: Partial<AuthenticationCreds>

  • reply: BinaryNode

Const createSignalIdentity

• createSignalIdentity(wid: string, accountSignatureKey: Uint8Array): SignalIdentity

• Parameters

  • wid: string

  • accountSignatureKey: Uint8Array

  Returns SignalIdentity

Const debouncedTimeout

• debouncedTimeout(intervalMs?: number, task?: () => void): { cancel: () => void; setInterval: (newInterval: number) => number; setTask: (newTask: () => void) => () => void; start: (newIntervalMs?: number, newTask?: () => void) => void }

• Parameters

  • intervalMs: number = 1000

  • task: () => void = ...

    • • (): void

      • Returns void

  Returns { cancel: () => void; setInterval: (newInterval: number) => number; setTask: (newTask: () => void) => () => void; start: (newIntervalMs?: number, newTask?: () => void) => void }

  • cancel: () => void

    • • (): void

      • Returns void

  • setInterval: (newInterval: number) => number

    • • (newInterval: number): number

      • Parameters

        • newInterval: number

        Returns number

  • setTask: (newTask: () => void) => () => void

    • • (newTask: () => void): () => void

      • Parameters

        • newTask: () => void

          • • (): void

            • Returns void

        Returns () => void

        • • (): void

          • Returns void

  • start: (newIntervalMs?: number, newTask?: () => void) => void

    • • (newIntervalMs?: number, newTask?: () => void): void

      • Parameters

        • Optional newIntervalMs: number

        • Optional newTask: () => void

          • • (): void

            • Returns void

        Returns void

Const decodeBinaryNode

• decodeBinaryNode(data: any): BinaryNode

• Parameters

  • data: any

  Returns BinaryNode

Const decodeMessageStanza

• decodeMessageStanza(stanza: BinaryNode, auth: AuthenticationState): Promise<{ author: string; chatId: string; failures: { error: Boom<any> }[]; from: string; msgId: string; participant: string; pushname: string; recipient: string; successes: Message[]; timestamp: number }>

• Parameters

  • stanza: BinaryNode

  • auth: AuthenticationState

  Returns Promise<{ author: string; chatId: string; failures: { error: Boom<any> }[]; from: string; msgId: string; participant: string; pushname: string; recipient: string; successes: Message[]; timestamp: number }>

Const decodePatches

• decodePatches(name: WAPatchName, syncds: ISyncdPatch[], initial: LTHashState, getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>, validateMacs?: boolean): Promise<{ newMutations: ChatMutation[]; state: LTHashState }>

• Parameters

  • name: WAPatchName

  • syncds: ISyncdPatch[]

  • initial: LTHashState

  • getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>

    • • (id: string): Awaitable<IAppStateSyncKeyData>

      • Parameters

        • id: string

        Returns Awaitable<IAppStateSyncKeyData>

  • validateMacs: boolean = true

  Returns Promise<{ newMutations: ChatMutation[]; state: LTHashState }>

Const decodeSyncdMutations

• decodeSyncdMutations(msgMutations: (ISyncdMutation | ISyncdRecord)[], initialState: LTHashState, getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>, validateMacs: boolean): Promise<{ hash: Buffer; indexValueMap: {}; mutations: ChatMutation[] }>

• Parameters

  • msgMutations: (ISyncdMutation | ISyncdRecord)[]

  • initialState: LTHashState

  • getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>

    • • (id: string): Awaitable<IAppStateSyncKeyData>

      • Parameters

        • id: string

        Returns Awaitable<IAppStateSyncKeyData>

  • validateMacs: boolean

  Returns Promise<{ hash: Buffer; indexValueMap: {}; mutations: ChatMutation[] }>

Const decodeSyncdPatch

• decodeSyncdPatch(msg: ISyncdPatch, name: WAPatchName, initialState: LTHashState, getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>, validateMacs: boolean): Promise<{ hash: Buffer; indexValueMap: {}; mutations: ChatMutation[] }>

• Parameters

  • msg: ISyncdPatch

  • name: WAPatchName

  • initialState: LTHashState

  • getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>

    • • (id: string): Awaitable<IAppStateSyncKeyData>

      • Parameters

        • id: string

        Returns Awaitable<IAppStateSyncKeyData>

  • validateMacs: boolean

  Returns Promise<{ hash: Buffer; indexValueMap: {}; mutations: ChatMutation[] }>

Const decodeSyncdSnapshot

• decodeSyncdSnapshot(name: WAPatchName, snapshot: ISyncdSnapshot, getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>, validateMacs?: boolean): Promise<LTHashState>

• Parameters

  • name: WAPatchName

  • snapshot: ISyncdSnapshot

  • getAppStateSyncKey: (id: string) => Awaitable<IAppStateSyncKeyData>

    • • (id: string): Awaitable<IAppStateSyncKeyData>

      • Parameters

        • id: string

        Returns Awaitable<IAppStateSyncKeyData>

  • validateMacs: boolean = true

  Returns Promise<LTHashState>

Const decryptGroupSignalProto

• decryptGroupSignalProto(group: string, user: string, msg: Buffer | Uint8Array, auth: SignalAuthState): any

• Parameters

  • group: string

  • user: string

  • msg: Buffer | Uint8Array

  • auth: SignalAuthState

  Returns any

decryptMediaMessageBuffer

• decryptMediaMessageBuffer(message: WAMessageContent): Promise<Readable>

• Decode a media message (video, image, document, audio) & return decrypted buffer

  Parameters

  • message: WAMessageContent

    the media message you want to decode

  Returns Promise<Readable>

Const decryptSignalProto

• decryptSignalProto(user: string, type: "pkmsg" | "msg", msg: Buffer | Uint8Array, auth: SignalAuthState): Promise<Buffer>

• Parameters

  • user: string

  • type: "pkmsg" | "msg"

  • msg: Buffer | Uint8Array

  • auth: SignalAuthState

  Returns Promise<Buffer>

Const default

• default(config: Partial<SocketConfig>): { appPatch: (patchCreate: WAPatchCreate) => Promise<void>; assertSession: (jid: string, force: boolean) => Promise<boolean>; assertingPreKeys: (range: number, execute: (keys: {}) => Promise<void>) => Promise<void>; authState: AuthenticationState; chatModify: (mod: ChatModification, jid: string, lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]) => Promise<void>; end: (error: Error) => void; ev: BaileysEventEmitter; fetchBlocklist: () => Promise<void>; fetchPrivacySettings: (force?: boolean) => Promise<{}>; fetchStatus: (jid: string) => Promise<{ setAt: Date; status: string }>; generateMessageTag: () => string; groupAcceptInvite: (code: string) => Promise<string>; groupCreate: (subject: string, participants: string[]) => Promise<GroupMetadata>; groupFetchAllParticipating: () => Promise<{}>; groupInviteCode: (jid: string) => Promise<string>; groupLeave: (id: string) => Promise<void>; groupMetadata: (jid: string) => Promise<GroupMetadata>; groupParticipantsUpdate: (jid: string, participants: string[], action: ParticipantAction) => Promise<string[]>; groupRevokeInvite: (jid: string) => Promise<string>; groupSettingUpdate: (jid: string, setting: "announcement" | "not_announcement" | "locked" | "unlocked") => Promise<void>; groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>; groupUpdateDescription: (jid: string, description?: string) => Promise<void>; groupUpdateSubject: (jid: string, subject: string) => Promise<void>; logout: () => Promise<void>; onWhatsApp: (...jids: string[]) => Promise<{ exists: boolean; jid: string }[]>; presenceSubscribe: (toJid: string) => Promise<void>; processMessage: (message: IWebMessageInfo, chatUpdate: Partial<Chat>) => Promise<void>; profilePictureUrl: (jid: string, type?: "preview" | "image") => Promise<string>; query: (node: BinaryNode, timeoutMs?: number) => Promise<BinaryNode>; refreshMediaConn: (forceGet?: boolean) => Promise<MediaConnInfo>; relayMessage: (jid: string, message: IMessage, __namedParameters: MessageRelayOptions) => Promise<string>; resyncAppState: (collections: WAPatchName[], returnSnapshot?: boolean) => Promise<ChatMutation[]>; resyncMainAppState: () => Promise<void>; sendDeliveryReceipt: (jid: string, participant: string, messageIds: string[]) => Promise<void>; sendMessage: (jid: string, content: AnyMessageContent, options?: MiscMessageGenerationOptions) => Promise<WebMessageInfo>; sendMessageAck: (__namedParameters: BinaryNode, extraAttrs: {}) => Promise<void>; sendNode: (node: BinaryNode) => Promise<void>; sendPresenceUpdate: (type: WAPresence, toJid?: string) => Promise<void>; sendRawMessage: (data: Buffer | Uint8Array) => Promise<void>; sendReadReceipt: (jid: string, participant: string, messageIds: string[]) => Promise<void>; updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>; updateProfilePicture: (jid: string, content: WAMediaUpload) => Promise<void>; user: Contact; waUploadToServer: WAMediaUploadFunction; waitForConnectionUpdate: (check: (u: Partial<ConnectionState>) => boolean, timeoutMs?: number) => Promise<void>; waitForMessage: (msgId: string, timeoutMs?: number) => Promise<any>; waitForSocketOpen: () => Promise<void>; ws: WebSocket }

• Parameters

  • config: Partial<SocketConfig>

  Returns { appPatch: (patchCreate: WAPatchCreate) => Promise<void>; assertSession: (jid: string, force: boolean) => Promise<boolean>; assertingPreKeys: (range: number, execute: (keys: {}) => Promise<void>) => Promise<void>; authState: AuthenticationState; chatModify: (mod: ChatModification, jid: string, lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]) => Promise<void>; end: (error: Error) => void; ev: BaileysEventEmitter; fetchBlocklist: () => Promise<void>; fetchPrivacySettings: (force?: boolean) => Promise<{}>; fetchStatus: (jid: string) => Promise<{ setAt: Date; status: string }>; generateMessageTag: () => string; groupAcceptInvite: (code: string) => Promise<string>; groupCreate: (subject: string, participants: string[]) => Promise<GroupMetadata>; groupFetchAllParticipating: () => Promise<{}>; groupInviteCode: (jid: string) => Promise<string>; groupLeave: (id: string) => Promise<void>; groupMetadata: (jid: string) => Promise<GroupMetadata>; groupParticipantsUpdate: (jid: string, participants: string[], action: ParticipantAction) => Promise<string[]>; groupRevokeInvite: (jid: string) => Promise<string>; groupSettingUpdate: (jid: string, setting: "announcement" | "not_announcement" | "locked" | "unlocked") => Promise<void>; groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>; groupUpdateDescription: (jid: string, description?: string) => Promise<void>; groupUpdateSubject: (jid: string, subject: string) => Promise<void>; logout: () => Promise<void>; onWhatsApp: (...jids: string[]) => Promise<{ exists: boolean; jid: string }[]>; presenceSubscribe: (toJid: string) => Promise<void>; processMessage: (message: IWebMessageInfo, chatUpdate: Partial<Chat>) => Promise<void>; profilePictureUrl: (jid: string, type?: "preview" | "image") => Promise<string>; query: (node: BinaryNode, timeoutMs?: number) => Promise<BinaryNode>; refreshMediaConn: (forceGet?: boolean) => Promise<MediaConnInfo>; relayMessage: (jid: string, message: IMessage, __namedParameters: MessageRelayOptions) => Promise<string>; resyncAppState: (collections: WAPatchName[], returnSnapshot?: boolean) => Promise<ChatMutation[]>; resyncMainAppState: () => Promise<void>; sendDeliveryReceipt: (jid: string, participant: string, messageIds: string[]) => Promise<void>; sendMessage: (jid: string, content: AnyMessageContent, options?: MiscMessageGenerationOptions) => Promise<WebMessageInfo>; sendMessageAck: (__namedParameters: BinaryNode, extraAttrs: {}) => Promise<void>; sendNode: (node: BinaryNode) => Promise<void>; sendPresenceUpdate: (type: WAPresence, toJid?: string) => Promise<void>; sendRawMessage: (data: Buffer | Uint8Array) => Promise<void>; sendReadReceipt: (jid: string, participant: string, messageIds: string[]) => Promise<void>; updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>; updateProfilePicture: (jid: string, content: WAMediaUpload) => Promise<void>; user: Contact; waUploadToServer: WAMediaUploadFunction; waitForConnectionUpdate: (check: (u: Partial<ConnectionState>) => boolean, timeoutMs?: number) => Promise<void>; waitForMessage: (msgId: string, timeoutMs?: number) => Promise<any>; waitForSocketOpen: () => Promise<void>; ws: WebSocket }

  • appPatch: (patchCreate: WAPatchCreate) => Promise<void>

    • • (patchCreate: WAPatchCreate): Promise<void>

      • Parameters

        • patchCreate: WAPatchCreate

        Returns Promise<void>

  • assertSession: (jid: string, force: boolean) => Promise<boolean>

    • • (jid: string, force: boolean): Promise<boolean>

      • Parameters

        • jid: string

        • force: boolean

        Returns Promise<boolean>

  • assertingPreKeys: (range: number, execute: (keys: {}) => Promise<void>) => Promise<void>

    • • (range: number, execute: (keys: {}) => Promise<void>): Promise<void>

      • get some pre-keys and do something with them

        Parameters

        • range: number

        • execute: (keys: {}) => Promise<void>

          • • (keys: {}): Promise<void>

            • Parameters

              • keys: {}

                • [_: number]: any

              Returns Promise<void>

        Returns Promise<void>

  • authState: AuthenticationState

  • chatModify: (mod: ChatModification, jid: string, lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]) => Promise<void>

    • • (mod: ChatModification, jid: string, lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]): Promise<void>

      • modify a chat -- mark unread, read etc. lastMessages must be sorted in reverse chronologically requires the last messages till the last message received; required for archive & unread

        Parameters

        • mod: ChatModification

        • jid: string

        • lastMessages: Pick<IWebMessageInfo, "key" | "messageTimestamp">[]

        Returns Promise<void>

  • end: (error: Error) => void

    • • (error: Error): void

      • Parameters

        • error: Error

        Returns void

  • ev: BaileysEventEmitter

  • fetchBlocklist: () => Promise<void>

    • • (): Promise<void>

      • Returns Promise<void>

  • fetchPrivacySettings: (force?: boolean) => Promise<{}>

    • • (force?: boolean): Promise<{}>

      • Parameters

        • force: boolean = false

        Returns Promise<{}>

  • fetchStatus: (jid: string) => Promise<{ setAt: Date; status: string }>

    • • (jid: string): Promise<{ setAt: Date; status: string }>

      • Parameters

        • jid: string

        Returns Promise<{ setAt: Date; status: string }>

  • generateMessageTag: () => string

    • • (): string

      • Returns string

  • groupAcceptInvite: (code: string) => Promise<string>

    • • (code: string): Promise<string>

      • Parameters

        • code: string

        Returns Promise<string>

  • groupCreate: (subject: string, participants: string[]) => Promise<GroupMetadata>

    • • (subject: string, participants: string[]): Promise<GroupMetadata>

      • Parameters

        • subject: string

        • participants: string[]

        Returns Promise<GroupMetadata>

  • groupFetchAllParticipating: () => Promise<{}>

    • • (): Promise<{}>

      • Returns Promise<{}>

  • groupInviteCode: (jid: string) => Promise<string>

    • • (jid: string): Promise<string>

      • Parameters

        • jid: string

        Returns Promise<string>

  • groupLeave: (id: string) => Promise<void>

    • • (id: string): Promise<void>

      • Parameters

        • id: string

        Returns Promise<void>

  • groupMetadata: (jid: string) => Promise<GroupMetadata>

    • • (jid: string): Promise<GroupMetadata>

      • Parameters

        • jid: string

        Returns Promise<GroupMetadata>

  • groupParticipantsUpdate: (jid: string, participants: string[], action: ParticipantAction) => Promise<string[]>

    • • (jid: string, participants: string[], action: ParticipantAction): Promise<string[]>

      • Parameters

        • jid: string

        • participants: string[]

        • action: ParticipantAction

        Returns Promise<string[]>

  • groupRevokeInvite: (jid: string) => Promise<string>

    • • (jid: string): Promise<string>

      • Parameters

        • jid: string

        Returns Promise<string>

  • groupSettingUpdate: (jid: string, setting: "announcement" | "not_announcement" | "locked" | "unlocked") => Promise<void>

    • • (jid: string, setting: "announcement" | "not_announcement" | "locked" | "unlocked"): Promise<void>

      • Parameters

        • jid: string

        • setting: "announcement" | "not_announcement" | "locked" | "unlocked"

        Returns Promise<void>

  • groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>

    • • (jid: string, ephemeralExpiration: number): Promise<void>

      • Parameters

        • jid: string

        • ephemeralExpiration: number

        Returns Promise<void>

  • groupUpdateDescription: (jid: string, description?: string) => Promise<void>

    • • (jid: string, description?: string): Promise<void>

      • Parameters

        • jid: string

        • Optional description: string

        Returns Promise<void>

  • groupUpdateSubject: (jid: string, subject: string) => Promise<void>

    • • (jid: string, subject: string): Promise<void>

      • Parameters

        • jid: string

        • subject: string

        Returns Promise<void>

  • logout: () => Promise<void>

    • • (): Promise<void>

      • logout & invalidate connection

        Returns Promise<void>

  • onWhatsApp: (...jids: string[]) => Promise<{ exists: boolean; jid: string }[]>

    • • (...jids: string[]): Promise<{ exists: boolean; jid: string }[]>

      • Parameters

        • Rest ...jids: string[]

        Returns Promise<{ exists: boolean; jid: string }[]>

  • presenceSubscribe: (toJid: string) => Promise<void>

    • • (toJid: string): Promise<void>

      • Parameters

        • toJid: string

        Returns Promise<void>

  • processMessage: (message: IWebMessageInfo, chatUpdate: Partial<Chat>) => Promise<void>

    • • (message: IWebMessageInfo, chatUpdate: Partial<Chat>): Promise<void>

      • Parameters

        • message: IWebMessageInfo

        • chatUpdate: Partial<Chat>

        Returns Promise<void>

  • profilePictureUrl: (jid: string, type?: "preview" | "image") => Promise<string>

    • • (jid: string, type?: "preview" | "image"): Promise<string>

      • fetch the profile picture of a user/group type = "preview" for a low res picture type = "image for the high res picture"

        Parameters

        • jid: string

        • type: "preview" | "image" = 'preview'

        Returns Promise<string>

  • query: (node: BinaryNode, timeoutMs?: number) => Promise<BinaryNode>

    • • (node: BinaryNode, timeoutMs?: number): Promise<BinaryNode>

      • send a query, and wait for its response. auto-generates message ID if not provided

        Parameters

        • node: BinaryNode

        • Optional timeoutMs: number

        Returns Promise<BinaryNode>

  • refreshMediaConn: (forceGet?: boolean) => Promise<MediaConnInfo>

    • • (forceGet?: boolean): Promise<MediaConnInfo>

      • Parameters

        • forceGet: boolean = false

        Returns Promise<MediaConnInfo>

  • relayMessage: (jid: string, message: IMessage, __namedParameters: MessageRelayOptions) => Promise<string>

    • • (jid: string, message: IMessage, __namedParameters: MessageRelayOptions): Promise<string>

      • Parameters

        • jid: string

        • message: IMessage

        • __namedParameters: MessageRelayOptions

        Returns Promise<string>

  • resyncAppState: (collections: WAPatchName[], returnSnapshot?: boolean) => Promise<ChatMutation[]>

    • • (collections: WAPatchName[], returnSnapshot?: boolean): Promise<ChatMutation[]>

      • Parameters

        • collections: WAPatchName[]

        • returnSnapshot: boolean = false

        Returns Promise<ChatMutation[]>

  • resyncMainAppState: () => Promise<void>

    • • (): Promise<void>

      • Returns Promise<void>

  • sendDeliveryReceipt: (jid: string, participant: string, messageIds: string[]) => Promise<void>

    • • (jid: string, participant: string, messageIds: string[]): Promise<void>

      • Parameters

        • jid: string

        • participant: string

        • messageIds: string[]

        Returns Promise<void>

  • sendMessage: (jid: string, content: AnyMessageContent, options?: MiscMessageGenerationOptions) => Promise<WebMessageInfo>

    • • (jid: string, content: AnyMessageContent, options?: MiscMessageGenerationOptions): Promise<WebMessageInfo>

      • Parameters

        • jid: string

        • content: AnyMessageContent

        • options: MiscMessageGenerationOptions = {}

        Returns Promise<WebMessageInfo>

  • sendMessageAck: (__namedParameters: BinaryNode, extraAttrs: {}) => Promise<void>

    • • (__namedParameters: BinaryNode, extraAttrs: {}): Promise<void>

      • Parameters

        • __namedParameters: BinaryNode

        • extraAttrs: {}

          • [key: string]: string

        Returns Promise<void>

  • sendNode: (node: BinaryNode) => Promise<void>

    • • (node: BinaryNode): Promise<void>

      • send a binary node

        Parameters

        • node: BinaryNode

        Returns Promise<void>

  • sendPresenceUpdate: (type: WAPresence, toJid?: string) => Promise<void>

    • • (type: WAPresence, toJid?: string): Promise<void>

      • Parameters

        • type: WAPresence

        • Optional toJid: string

        Returns Promise<void>

  • sendRawMessage: (data: Buffer | Uint8Array) => Promise<void>

    • • (data: Buffer | Uint8Array): Promise<void>

      • send a raw buffer

        Parameters

        • data: Buffer | Uint8Array

        Returns Promise<void>

  • sendReadReceipt: (jid: string, participant: string, messageIds: string[]) => Promise<void>

    • • (jid: string, participant: string, messageIds: string[]): Promise<void>

      • Parameters

        • jid: string

        • participant: string

        • messageIds: string[]

        Returns Promise<void>

  • updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>

    • • (jid: string, action: "block" | "unblock"): Promise<void>

      • Parameters

        • jid: string

        • action: "block" | "unblock"

        Returns Promise<void>

  • updateProfilePicture: (jid: string, content: WAMediaUpload) => Promise<void>

    • • (jid: string, content: WAMediaUpload): Promise<void>

      • Parameters

        • jid: string

        • content: WAMediaUpload

        Returns Promise<void>

  • user: Contact

  • waUploadToServer: WAMediaUploadFunction

  • waitForConnectionUpdate: (check: (u: Partial<ConnectionState>) => boolean, timeoutMs?: number) => Promise<void>

    • • (check: (u: Partial<ConnectionState>) => boolean, timeoutMs?: number): Promise<void>

      • Waits for the connection to WA to reach a state

        Parameters

        • check: (u: Partial<ConnectionState>) => boolean

          • • (u: Partial<ConnectionState>): boolean

            • Parameters

              • u: Partial<ConnectionState>

              Returns boolean

        • Optional timeoutMs: number

        Returns Promise<void>

  • waitForMessage: (msgId: string, timeoutMs?: number) => Promise<any>

    • • (msgId: string, timeoutMs?: number): Promise<any>

      • Wait for a message with a certain tag to be received

        Parameters

        • msgId: string

        • timeoutMs: number = ...

          timeout after which the promise will reject

        Returns Promise<any>

  • waitForSocketOpen: () => Promise<void>

    • • (): Promise<void>

      • Returns Promise<void>

  • ws: WebSocket