Client & Lifecycle

import { Client } from 'zaileys'
 
const client = new Client({ sessionId: 'default' })
 
client.on('connect', ({ me }) => console.log('ready as', me.id))

import { Client } from 'zaileys'
 
const client = new Client({
  sessionId: 'support-bot',
  authType: 'qr',
  ignoreMe: true,
  reconnect: { maxAttempts: 10, initialDelayMs: 2000, maxDelayMs: 30_000 },
})

import { Client } from 'zaileys'
 
const client = new Client({
  authType: 'pairing',
  phoneNumber: '628123456789',
})
 
client.on('pairing-code', ({ code, expiresAt }) => {
  console.log('Enter this code on WhatsApp:', code, '(expires', new Date(expiresAt), ')')
})

type ConnectionState =
  | 'idle'
  | 'connecting'
  | 'qr-pending'
  | 'pairing-pending'
  | 'connected'
  | 'reconnecting'
  | 'disconnecting'
  | 'disconnected'

connect(): Promise<void>

import { Client } from 'zaileys'
 
const client = new Client() // connects automatically
 
// These run on the same tick, before the queued connect() fires
client.on('qr', ({ qrString }) => console.log(qrString))
client.on('message', (ctx) => console.log(ctx.text))

client.on('reconnecting', ({ attempt, delayMs, reason }) => {
  console.log(`reconnect #${attempt} in ${delayMs}ms (reason: ${reason})`)
})

disconnect(): Promise<void>

await client.disconnect()
console.log(client.state) // 'disconnected'

logout(): Promise<void>

await client.logout() // unlinks the device and clears local auth

client.on('connect', ({ me }) => console.log('me:', me.id))
 
const onText = (ctx) => console.log(ctx.text)
client.on('text', onText)
client.off('text', onText) // detach when done

import { Client, type Middleware } from 'zaileys'
 
const client = new Client({ commandPrefix: ['/', '!'] })
 
const logging: Middleware = async (ctx, next) => {
  console.log(`[command] ${ctx.command} from ${ctx.senderId}`)
  await next()
}
 
client
  .use(logging)
  .command('ping', async (ctx) => {
    await ctx.reply('pong')
  })
  .command('help|h|?', async (ctx) => {
    await ctx.reply('Commands: /ping, /help')
  })

const key = await client.send('628123456789@s.whatsapp.net').text('Original')

import { Client } from 'zaileys'
 
const client = new Client()
const jid = '628123456789@s.whatsapp.net'
const otherJid = '628987654321@s.whatsapp.net'
 
const key = await client.send(jid).text('Original')
 
await client.edit(key).text('Edited text')   // edit in place
await client.react(key, '👍')                 // add reaction
await client.react(key, '')                    // remove reaction
await client.delete(key, { forEveryone: true }) // unsend for everyone
await client.forward(key, otherJid)            // forward to another chat

const groupJid = '120363000000000000@g.us'
 
const meta = await client.group.metadata(groupJid)
console.log(meta.subject, meta.participants.length)
 
await client.group.addMember(groupJid, ['628111111111@s.whatsapp.net'])
await client.group.promote(groupJid, ['628111111111@s.whatsapp.net'])
await client.group.setting(groupJid, 'announcement') // only admins can send
 
const code = await client.group.inviteCode(groupJid)
console.log('Join link: https://chat.whatsapp.com/' + code)

const jid = '628123456789@s.whatsapp.net'
 
await client.presence.online()
await client.presence.typing(jid, 3000) // typing… auto-clears after 3s
await client.send(jid).text('Done thinking!')

await client.privacy.set({
  lastSeen: 'contacts',
  online: 'match_last_seen',
  readReceipts: false, // → 'none'
  groupAdd: 'contacts',
})
 
const settings = await client.privacy.get()
console.log(settings)
 
await client.privacy.block('628999999999@s.whatsapp.net')
console.log(await client.privacy.blocklist())

const channel = await client.newsletter.create('zaileys updates', {
  description: 'Release notes and tips',
})
console.log('created channel', channel.id)
 
await client.newsletter.updateDescription(channel.id, 'Now with scheduling!')
await client.newsletter.follow('120363111111111111@newsletter')

const community = await client.community.create('Devs', 'Welcome to the dev community')
 
await client.community.linkGroup(community.id, '120363000000000000@g.us')
const groups = await client.community.subGroups(community.id)
console.log('linked groups:', groups.map((g) => g.subject))

import { Client } from 'zaileys'
 
const client = new Client({ sessionId: 'demo', autoConnect: false })
 
client.on('qr', ({ qrString }) => console.log('Scan QR:', qrString))
client.on('reconnecting', ({ attempt, delayMs }) =>
  console.log(`reconnecting #${attempt} in ${delayMs}ms`),
)
client.on('error', ({ error }) => console.error('client error:', error.message))
 
client.on('connect', async ({ me }) => {
  console.log('connected as', me.id)
  await client.presence.online()
})
 
client.on('text', async (ctx) => {
  if (ctx.text?.toLowerCase() === 'ping') {
    const key = await client.send(ctx.roomId).text('pong')
    await client.react(key, '🏓')
  }
})
 
await client.connect()
 
// later, on shutdown:
process.on('SIGINT', async () => {
  await client.disconnect()
  process.exit(0)
})