Kaizen
Browse modulesChatchat/serverchat/server/socket-ioInterfaces

Interface: ChatGatewayOptions

Defined in: server/chat/socket-io/gateway.ts:32

Properties

allowedOrigins

allowedOrigins: readonly string[];

Defined in: server/chat/socket-io/gateway.ts:35


authenticate

authenticate: (request: IncomingMessage, context: {
  signal: AbortSignal;
}) => Promise<ChatSession | null>;

Defined in: server/chat/socket-io/gateway.ts:39

Parameters

ParameterType
requestIncomingMessage
context{ signal: AbortSignal; }
context.signalAbortSignal

Returns

Promise<ChatSession | null>


authorizeSubscription

authorizeSubscription: (principal: {
  actorId: string;
  organizationId: string;
}, input: {
  conversationId: string;
}, context: {
  signal: AbortSignal;
}) => Promise<ChatSubscription>;

Defined in: server/chat/socket-io/gateway.ts:43

Parameters

ParameterType
principal{ actorId: string; organizationId: string; }
principal.actorIdstring
principal.organizationIdstring
input{ conversationId: string; }
input.conversationIdstring
context{ signal: AbortSignal; }
context.signalAbortSignal

Returns

Promise<ChatSubscription>


httpServer

httpServer: Server;

Defined in: server/chat/socket-io/gateway.ts:33


limits?

optional limits?: {
  actionsPerMinute?: number;
  authorizationTimeoutMs?: number;
  maxConnections?: number;
  maxSubscriptionsPerConnection?: number;
  presenceTtlMs?: number;
  revalidateIntervalMs?: number;
  typingTtlMs?: number;
};

Defined in: server/chat/socket-io/gateway.ts:48

actionsPerMinute?

optional actionsPerMinute?: number;

authorizationTimeoutMs?

optional authorizationTimeoutMs?: number;

maxConnections?

optional maxConnections?: number;

maxSubscriptionsPerConnection?

optional maxSubscriptionsPerConnection?: number;

presenceTtlMs?

optional presenceTtlMs?: number;

revalidateIntervalMs?

optional revalidateIntervalMs?: number;

typingTtlMs?

optional typingTtlMs?: number;

onDiagnostics?

optional onDiagnostics?: (diagnostics: Readonly<ChatGatewayDiagnostics>) => void;

Defined in: server/chat/socket-io/gateway.ts:38

Aggregate counters at revalidation ticks, at most once/second. No identities or content.

Parameters

ParameterType
diagnosticsReadonly<ChatGatewayDiagnostics>

Returns

void


path?

optional path?: string;

Defined in: server/chat/socket-io/gateway.ts:36


redis

redis: ChatRedisOptions;

Defined in: server/chat/socket-io/gateway.ts:34

On this page