From ce84d3efee7186150c89698916e7211a2423a839 Mon Sep 17 00:00:00 2001 From: Danial Raza Date: Sat, 30 Dec 2023 18:40:20 +0100 Subject: [PATCH] fix(Gateway): Export interface (#10060) * fix(types): export missing `Gateway` interface * docs(Gateway): update link to `WebSocketManager` --- packages/core/src/Gateway.ts | 5 +++++ packages/core/src/index.ts | 1 + 2 files changed, 6 insertions(+) diff --git a/packages/core/src/Gateway.ts b/packages/core/src/Gateway.ts index f9c3778bb..86edd5be9 100644 --- a/packages/core/src/Gateway.ts +++ b/packages/core/src/Gateway.ts @@ -2,6 +2,11 @@ import type { Awaitable } from '@discordjs/util'; import type { ManagerShardEventsMap, WebSocketShardEvents } from '@discordjs/ws'; import type { GatewaySendPayload } from 'discord-api-types/v10'; +/** + * Gateway-like structure that can be used to interact with an actual WebSocket connection. + * You can provide a custom implementation, useful for running a message broker between your app and your gateway, + * or you can simply use the {@link @discordjs/ws#(WebSocketManager:class)}. + */ export interface Gateway { getShardCount(): Awaitable; on( diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index 33b31b760..03a97ad41 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -1,5 +1,6 @@ export * from './api/index.js'; export * from './client.js'; +export * from './Gateway.js'; export * from './util/index.js'; export * from 'discord-api-types/v10';