> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/whiskeysockets/Baileys/llms.txt
> Use this file to discover all available pages before exploring further.
# Socket Configuration
> Socket configuration types and cache store interfaces
Configuration types for creating and managing WhatsApp socket connections.
## SocketConfig
Complete configuration object for `makeWASocket()`.
### Connection Settings
The WebSocket URL to connect to WhatsApp servers
Default: `'wss://web.whatsapp.com/ws/chat'`
Connection timeout in milliseconds. Fails if socket doesn't connect within this time.
Default: `20000` (20 seconds)
Default timeout for queries in milliseconds. `undefined` for no timeout.
Default: `60000` (60 seconds)
Ping-pong interval for WebSocket connection in milliseconds
Default: `25000` (25 seconds)
Proxy agent for WebSocket connection
Agent used for HTTP fetch requests (uploading/downloading media)
### Client Identification
WhatsApp Web version to connect with
Type: `[number, number, number]`
Example: `[2, 2323, 4]`
Browser identification sent to WhatsApp
Type: `[string, string, string]`
Example: `['Baileys', 'Chrome', '1.0.0']`
Alphanumeric country code for the number (e.g., 'US', 'BR', 'IN')
### Authentication
Authentication state object containing credentials and keys
See [AuthenticationState](/api/auth/auth-state)
Options for SignalKeyStore transaction capability
Maximum number of retries for transaction commits
Delay between retry attempts in milliseconds
### Logging and Events
Logger instance for debug output
Whether to emit events for actions done by this socket connection
Default: `true`
### History and Sync
Whether to ask the phone for full history (received asynchronously)
Default: `false`
Control which history messages to sync
```typescript theme={null}
(msg: proto.Message.IHistorySyncNotification) => boolean
```
Return `true` to sync, `false` to skip
Whether to automatically fire initialization queries
Default: `true`
### Message Handling
Fetch a message from your store for retry logic
```typescript theme={null}
(key: WAMessageKey) => Promise
```
Required for handling "this message can take a while" issues
Optionally modify messages before sending
```typescript theme={null}
(msg: proto.IMessage, recipientJids?: string[]) =>
| Promise
| PatchedMessageWithRecipientJID[]
| PatchedMessageWithRecipientJID
```
Determine if a JID should be ignored (no events, no decryption)
```typescript theme={null}
(jid: string) => boolean | undefined
```
### Media
Custom upload hosts for media
Width for link preview images in pixels
Default: `192`
Generate high quality link previews (uploads jpegThumbnail to WhatsApp)
Default: `false`
### Retry and Error Handling
Time to wait between sending retry requests in milliseconds
Default: `250`
Maximum retry count for messages
Default: `5`
Time to wait for QR code generation in milliseconds
Default: `60000` (60 seconds)
Enable automatic session recreation for failed messages
Default: `false`
Enable recent message caching for retry handling
Default: `false`
### Caching
Cache to store media to avoid re-uploading
See [CacheStore](#cachestore)
Cache to track retry counts for failed messages
Cache to store user device lists
Cache to store call offers
Cache to track placeholder resends
Fetch cached group metadata to speed up message sending
```typescript theme={null}
(jid: string) => Promise
```
### Advanced
Mark client as online when socket connects
Default: `true`
Verify app state MACs
```typescript theme={null}
{
patch: boolean
snapshot: boolean
}
```
Options for HTTP fetch requests
Factory function for creating signal repositories
```typescript theme={null}
(
auth: SignalAuthState,
logger: ILogger,
pnToLIDFunc?: (jids: string[]) => Promise
) => SignalRepositoryWithLIDStore
```
## CacheStore
Interface for cache implementations used throughout Baileys.
Get a cached key
```typescript theme={null}
get(key: string): Promise | T | undefined
```
Set a key in the cache
```typescript theme={null}
set(key: string, value: T): Promise | void | number | boolean
```
Delete a key from the cache
```typescript theme={null}
del(key: string): void | Promise | number | boolean
```
Flush all data from cache
```typescript theme={null}
flushAll(): void | Promise
```
## PossiblyExtendedCacheStore
Extended cache store with batch operations:
Get multiple keys at once
```typescript theme={null}
mget?(keys: string[]): Promise>
```
Set multiple keys at once
```typescript theme={null}
mset?(entries: { key: string; value: T }[]):
Promise | void | number | boolean
```
Delete multiple keys at once
```typescript theme={null}
mdel?(keys: string[]): void | Promise | number | boolean
```
## Supporting Types
### WAVersion
```typescript theme={null}
type WAVersion = [number, number, number]
// Example:
const version: WAVersion = [2, 2323, 4]
```
### WABrowserDescription
```typescript theme={null}
type WABrowserDescription = [string, string, string]
// Example:
const browser: WABrowserDescription = ['Baileys', 'Chrome', '1.0.0']
```
### PatchedMessageWithRecipientJID
```typescript theme={null}
type PatchedMessageWithRecipientJID = proto.IMessage & {
recipientJid?: string
}
```
## Example Configuration
```typescript theme={null}
import makeWASocket, {
DisconnectReason,
useMultiFileAuthState,
makeCacheableSignalKeyStore
} from '@whiskeysockets/baileys'
import NodeCache from 'node-cache'
import pino from 'pino'
const logger = pino({ level: 'debug' })
const { state, saveCreds } = await useMultiFileAuthState('./auth_info')
// Create cache instances
const msgRetryCounterCache = new NodeCache()
const userDevicesCache = new NodeCache()
const sock = makeWASocket({
version: [2, 2323, 4],
logger,
auth: {
creds: state.creds,
keys: makeCacheableSignalKeyStore(state.keys, logger)
},
browser: ['Baileys', 'Chrome', '1.0.0'],
// Message handling
getMessage: async (key) => {
return await getMessageFromDB(key)
},
// Caching
msgRetryCounterCache,
userDevicesCache,
// Group metadata caching
cachedGroupMetadata: async (jid) => {
return await getGroupMetadataFromDB(jid)
},
// Sync settings
syncFullHistory: true,
shouldSyncHistoryMessage: (msg) => {
// Only sync last 30 days
const thirtyDaysAgo = Date.now() - (30 * 24 * 60 * 60 * 1000)
return msg.messageTimestamp > thirtyDaysAgo
},
// Connection settings
connectTimeoutMs: 60000,
defaultQueryTimeoutMs: 60000,
keepAliveIntervalMs: 30000,
// Advanced
emitOwnEvents: false,
markOnlineOnConnect: true,
generateHighQualityLinkPreview: true
})
// Save credentials on update
sock.ev.on('creds.update', saveCreds)
```