API Reference

A grouped, quick-lookup index of every public export from the zaileys package. Everything below is re-exported from the package root, so a single import works for any symbol:

import { Client, MessageBuilder, SqliteAuthStore, SqliteMessageStore } from 'zaileys'

Client

The main entry point. See Client & Lifecycle and Configuration.

import { Client, MemoryAuthStore, MemoryMessageStore } from 'zaileys'
 
const client = new Client({
  sessionId: 'main',
  auth: new MemoryAuthStore(),
  store: new MemoryMessageStore(),
  authType: 'qr',
  qrTerminal: true,
})
 
client.on('connect', ({ me }) => console.log('connected as', me.id))
client.on('text', (ctx) => {
  if (ctx.text === 'ping') ctx.reply('pong')
})

Related client exports: TypedEventEmitter, TypedEventEmitterOptions.

Configuration Types

Types backing the Client constructor. See Configuration.

Auth Stores

Credential persistence. Pass an instance to Client’s auth option. See Storage Adapters.

import { Client, SqliteAuthStore } from 'zaileys'
 
const client = new Client({
  sessionId: 'main',
  auth: new SqliteAuthStore({ path: './session.db' }),
})

Message Stores

Chat/message/contact/presence persistence. Pass to Client’s store option. See Storage Adapters.

Builder (Sending Messages)

Fluent message construction. See Sending Messages, Interactive Messages, Rich Responses.

client
  .send('628xxx@s.whatsapp.net')
  .text('Hello *world*')
  .reply(msg.message().key)

MessageBuilder<State>

EditBuilder

Builder mutations & helpers

Builder types

BuilderState, BuilderContext, MediaSource, ImageOptions, VideoOptions, VideoNoteOptions, AudioOptions, DocumentOptions, StickerOptions, AlbumItem, ListOptions, ListSection, PollOptions, LocationOptions, TemplateOptions, EventOptions, GroupInviteOptions, ProductOptions, ButtonDef, InteractiveButton (ReplyButton, UrlButton, CopyButton, CallButton, ReminderButton, CancelReminderButton, LocationRequestButton, AddressButton), BottomSheetOptions, LimitedTimeOfferOptions.

Events

Inbound event payloads and helpers. See Events.

client.on('message', (ctx) => console.log(ctx.chatType, ctx.text, ctx.senderId))
client.on('text', (ctx) => console.log(ctx.text, ctx.senderId))
client.on('call-incoming', (call) => console.log(call))

The message event is an umbrella that fires once for any inbound message regardless of type, delivering the same MessageContext as the typed events (text, image, …). Use it as a single catch-all entry point.

MessageContext notes:

• uniqueId — 16-char uppercase hex, stable per message (remoteJid|id|fromMe).
• staticId — 16-char uppercase hex, stable per room + sender (same value for every message from one sender in one room).
• mentions — resolved to PN (LID mentions mapped back to phone-number JIDs).
• senderDevice — detected (android | ios | web | desktop | unknown).
• Content-derived flags: isEdited, isDeleted, isPinned, isUnPinned, isBot, isStatusMention, isGroupStatusMention, isStory, isHideTags.
• chatType values include album, group-invite, product, order, payment (plus text/image/video/audio/document/sticker/poll/contact/location/live-location/event/buttons/list/interactive/template/unknown).

ctx.media variants

ctx.media is a discriminated union keyed on type. New variants added in v4.4 (all fields nullable unless noted):

Commands

Prefix-based command routing. See Commands.

client.command('ping', async (ctx) => ctx.reply('pong'))
client.use(async (ctx, next) => { console.log(ctx.command); await next() })

Automation

Rate limiting, queues, broadcast, scheduling, presence. See Broadcast & Schedule.

Domain Modules

Accessed via client.group, client.privacy, client.newsletter, client.community, client.profile, client.chat, client.contact, client.business. Full guides: Groups · Communities · Newsletters · Privacy & Blocking. See also Client & Lifecycle.

const meta = await client.group.metadata('xxx@g.us')
await client.group.addMember('xxx@g.us', ['628xxx@s.whatsapp.net'])

GroupModule

create, addMember, removeMember, promote, demote, updateSubject, updateDescription, leave, metadata, tagMember, inviteCode, revokeInvite, acceptInvite, toggleEphemeral, setting, list, inviteInfo, joinRequests, approveJoin, rejectJoin, joinApproval, memberAddMode.

PrivacyModule

set, get, block, unblock, blocklist, disappearingMode.

NewsletterModule

create, follow, unfollow, metadata, updateName, updateDescription, updatePicture, mute, unmute, delete, removePicture, react, unreact, subscribers, messages, adminCount, changeOwner, demote.

CommunityModule

create, createGroup, linkGroup, unlinkGroup, subGroups, leave, updateSubject, updateDescription, inviteCode, revokeInvite, acceptInvite, metadata, list, inviteInfo, toggleEphemeral, setting, memberAddMode, joinApproval.

ProfileModule

setName, setStatus, setPicture, removePicture, getPicture, getStatus.

ChatModule

archive, unarchive, pin, unpin, mute, unmute, markRead, markUnread, star, unstar, delete, clear.

ContactModule

check, exists, save, remove. Type: ContactCheckResult.

BusinessModule

profile, catalog, collections, orderDetails, createProduct, updateProduct, deleteProduct.

Domain types: ParticipantUpdateResult, PrivacyConfig, PrivacySettings, LinkedGroup, DomainSocketLike.

Media

FFmpeg/sharp-backed media processing. See Media.

import { Media } from 'zaileys'
 
const m = new Media('./input.mp3')
const opus = await m.audio.toOpus()
const thumb = await m.video.thumbnail()

Connection

Lower-level connection primitives (advanced). See Client & Lifecycle.

Utilities

See Utilities for full signatures and examples.

Errors

Typed error classes per subsystem. Each carries a discriminated code. See Error Handling for handling patterns.

import { ZaileysBuilderError } from 'zaileys'
 
try {
  await client.send(jid).text('hi')
} catch (e) {
  if (e instanceof ZaileysBuilderError) console.error(e.code, e.message)
}

Misc Types