SHARDWIRE
ReferenceBridge APIs

AppBridgeOptions

Reference for `AppBridgeOptions`, exported as part of the public Shardwire surface.

interface exported from src/discord/types.ts.

Summary

Reference for AppBridgeOptions, exported as part of the public Shardwire surface.

Signature

export interface AppBridgeOptions {
	url: string;
	secret: string;
	secretId?: string;
	appName?: string;
	reconnect?: {
		enabled?: boolean;
		initialDelayMs?: number;
		maxDelayMs?: number;
		jitter?: boolean;
	};
	requestTimeoutMs?: number;
	/**
	 * When true, enables **debug** logging for the connection handshake (WebSocket open, auth, negotiated capabilities)
	 * if you did not supply a custom {@link ShardwireLogger.debug} implementation. Uses `console.debug` with a `[shardwire]` prefix.
	 */
	debug?: boolean;
	logger?: ShardwireLogger;
	metrics?: AppBridgeMetricsHooks;
}

Structure

On this page