Adhiraj Singh
d386f2db8b
* feat: add legacy connection * fix: merge conflict errors * feat: functional legacy socket
40 lines
1.3 KiB
TypeScript
40 lines
1.3 KiB
TypeScript
|
|
import type { Agent } from "https"
|
|
import type { Logger } from "pino"
|
|
import type { URL } from "url"
|
|
import type NodeCache from 'node-cache'
|
|
|
|
export type WAVersion = [number, number, number]
|
|
export type WABrowserDescription = [string, string, string]
|
|
|
|
export type CommonSocketConfig<T> = {
|
|
/** provide an auth state object to maintain the auth state */
|
|
auth?: T
|
|
/** the WS url to connect to WA */
|
|
waWebSocketUrl: string | URL
|
|
/** Fails the connection if the socket times out in this interval */
|
|
connectTimeoutMs: number
|
|
/** Default timeout for queries, undefined for no timeout */
|
|
defaultQueryTimeoutMs: number | undefined
|
|
/** ping-pong interval for WS connection */
|
|
keepAliveIntervalMs: number
|
|
/** proxy agent */
|
|
agent?: Agent
|
|
/** pino logger */
|
|
logger: Logger
|
|
/** version to connect with */
|
|
version: WAVersion
|
|
/** override browser config */
|
|
browser: WABrowserDescription
|
|
/** agent used for fetch requests -- uploading/downloading media */
|
|
fetchAgent?: Agent
|
|
/** should the QR be printed in the terminal */
|
|
printQRInTerminal: boolean
|
|
/** should events be emitted for actions done by this socket connection */
|
|
emitOwnEvents: boolean
|
|
/** provide a cache to store media, so does not have to be re-uploaded */
|
|
mediaCache?: NodeCache
|
|
|
|
customUploadHosts: string[]
|
|
}
|