Types
Every interface and type alias that lunibee exports, with what it is for. Each name links to its full definition in the generated API reference. The classes and functions that use these types are described on the other reference pages.
377 types in 12 packages.
@lunibee/builders
Section titled “@lunibee/builders”| Type | Kind | Description |
|---|---|---|
APIActionRowPayload |
interface | An action row as a builder sends it: up to five buttons, or one select menu or text input. |
APIButtonPayload |
interface | A button as a builder sends it. |
APIComponentEmoji |
interface | An emoji on a button or select option: a custom emoji id, or a Unicode name. |
APIContainerComponent |
interface | A Components V2 container: a box around other components, with an optional accent colour. |
APIContentInventoryEntryComponent |
interface | A Components V2 content inventory entry. |
APIEntitySelectComponent |
interface | A user, role, mentionable or channel select menu as Discord receives it. |
APIFileComponent |
interface | A Components V2 file display for an uploaded attachment. |
APIMediaGalleryComponent |
interface | A Components V2 media gallery; each item is `{ media: { url }, description?, spoiler? |
APIModalComponent |
interface | A modal (callback type 9 data): title, custom ID and its components. |
APISectionComponent |
interface | A Components V2 section: up to three text displays with an accessory. |
APISelectDefaultValue |
interface | Default values accepted by an auto-populated entity select. |
APISelectOption |
interface | One option of a string select menu. |
APISeparatorComponent |
interface | A Components V2 separator, with optional divider line and spacing. |
APIStringSelectComponent |
interface | A string select menu (component type 3) as Discord receives it. |
APITextDisplayComponent |
interface | A Components V2 text display (Markdown content). |
APITextInputPayload |
interface | A modal text input as a builder sends it. |
APIThumbnailComponent |
interface | A Components V2 thumbnail: `{ type: 11, media: { url }, description?, spoiler? |
AttachmentData |
interface | Options for CreateAttachment: file name, alt-text description, the contents or a file path, and an optional root folder the path must stay inside. |
EmbedField |
interface | Discord API embed field payload. |
APIActionRowChild |
type | Any component an action row can hold: a button, a select menu or a text input. |
APIComponent |
type | Any top-level message component: an action row or a Components V2 layout component. |
TextInputType |
type | One TextInputType value, usable as a type. |
@lunibee/collection
Section titled “@lunibee/collection”| Type | Kind | Description |
|---|---|---|
CacheOptions |
interface | Cache policy for bounded resource storage. |
CollectionOptions |
interface | Retention policy for a Collection. |
CollectionStats |
interface | Cumulative counters from Collection.stats. |
RedisCollectionOptions |
interface | Options for RedisCollection. |
RedisCommandClient |
interface | Anything that runs one Redis command: Bun.RedisClient as it is, or an adapter. |
RedisSerializer |
interface | Turns values into strings for Redis and back. |
EvictionReason |
type | Why an entry was removed automatically. |
Keep |
type | What merge() does with one entry: keep it with value, or drop it. |
ReadonlyCollection |
type | A Collection seen read-only: every method that does not change it. |
@lunibee/core
Section titled “@lunibee/core”| Type | Kind | Description |
|---|---|---|
Api |
interface | Discord’s REST API as a path you build by chaining: a name goes one level down, a call with an id goes into that item, and a method sends. |
ApplicationNode |
interface | A place in Discord’s REST API. |
BooleanConfig |
interface | A true/false option. |
ChannelConfig |
interface | A channel option. |
ChannelNode |
interface | A place in Discord’s REST API. |
ChoiceConfig |
interface | A choice between fixed words. |
CollectorOptions |
interface | - ComponentCollectorOptions |
Command |
interface | A command made by command. |
CommandContext |
interface | What a command handler gets, whether it was run as /name or as !name. |
CommandDefinition |
interface | The definition command() takes. |
CreateCategoryChannel |
interface | A category. |
CreateForumChannel |
interface | A forum or media channel. |
CreateTextChannel |
interface | A text or announcement channel. |
CreateVoiceChannel |
interface | A voice or stage channel. |
GuildNode |
interface | A place in Discord’s REST API. |
Handle |
interface | A reference to one Discord thing by its ids. |
ListRoute |
interface | A route that lists things and can follow its pages. |
MemberNode |
interface | A place in Discord’s REST API. |
MembersRoute |
interface | A route that lists things and can follow its pages. |
MentionableValue |
interface | A mention or id that can be either a user or a role. |
MessageNode |
interface | A place in Discord’s REST API. |
MessagesRoute |
interface | A route that lists things and can follow its pages. |
NumberConfig |
interface | An integer or number option. |
OptionDef |
interface | One option of a command. |
PageOptions |
interface | How a list is paged. |
RawDispatchSource |
interface | What attach() listens to: a Client (its raw event) or a Gateway (RAW). |
RedisCacheDiagnostics |
interface | Health of a RedisCache. |
RedisCacheOptions |
interface | Options for RedisCache. |
Route |
interface | A place in Discord’s REST API. |
RouteOptions |
interface | Extra settings for one request. |
StringConfig |
interface | A string option. |
UserNode |
interface | A place in Discord’s REST API. |
ClientEventName |
type | Names of events emitted by a Lunibee client. |
ClientEvents |
type | Every Client event name mapped to its listener arguments. |
ClientListener |
type | Listener signature for a Lunibee client event. |
ClientState |
type | Lifecycle state of a client. |
CreateChannelOptions |
type | The options for guild.createChannel(); kind decides which others apply. |
Duration |
type | A length of time: milliseconds, or text such as "90s", "10m", "2h", "1d", "1w" or "1h30m". |
MessageInput |
type | Message text, or a full payload. |
OptionMap |
type | The options of a command, by name. |
OptionValues |
type | The values a handler receives: required (or defaulted) options always, the rest possibly missing. |
RouteId |
type | What goes in a path where Discord wants an id: a snowflake, "@me", an invite code, an emoji. |
WebhookNode |
type | webhooks(id) is the webhook; webhooks(id)(token) is its execute route, with messages(id) inside. |
@lunibee/formatters
Section titled “@lunibee/formatters”| Type | Kind | Description |
|---|---|---|
TimestampStyle |
type | Discord timestamp style formats. |
@lunibee/managers
Section titled “@lunibee/managers”| Type | Kind | Description |
|---|---|---|
APIBan |
interface | Raw Discord ban object. |
AuditLogResponse |
interface | Discord API audit log response payload. |
BanOptions |
interface | Options for banning a member: audit-log reason and how many seconds of their messages to delete. |
ChannelCreateOptions |
interface | - Record<string, unknown> |
EmojiCreateOptions |
interface | Strict payload for creating a custom guild emoji. |
EmojiEditOptions |
interface | Strict payload for editing a custom guild emoji. |
EntitlementQuery |
interface | Filters for MonetizationManager.fetchEntitlements. |
GuildBanCreateOptions |
interface | Options for GuildBanManager.create. |
GuildStickerCreateOptions |
interface | Fields for GuildStickerManager.create. |
MemberEditOptions |
interface | Fields that can change when editing a guild member (nickname, roles, voice state, timeout). |
MessageCacheOptions |
interface | Opt-in per-channel message cache. |
MessageFetchOptions |
interface | Options for fetching one message; cache: false skips storing it. |
MessageQueryOptions |
interface | Pagination for fetching a channel’s messages: before, after or around an ID, and a limit. |
MessageThreadOptions |
interface | Options for starting a thread from a message. |
PermissionOverwriteOptions |
interface | Permission values accepted by PermissionOverwriteManager.edit. |
PermissionOverwriteUpdate |
interface | Bits to change on one overwrite by PermissionOverwriteManager.update; bits in none of them keep their state. |
ReactionFetchOptions |
interface | Pagination for listing the users who reacted with an emoji. |
RoleCreateOptions |
interface | - RoleStyleOptions |
RoleEditOptions |
interface | - RoleStyleOptions |
SoundboardSoundCreateOptions |
interface | Fields for GuildSoundboardManager.create. |
StageInstanceCreateOptions |
interface | Options for creating a stage instance. |
ApplicationCommandInput |
type | Command data, or a builder such as CreateSlashCommand (its toJSON() is sent). |
ChannelEditOptions |
type | Audit-log reason. |
GuildScheduledEventOptions |
type | Fields accepted when creating or editing a scheduled event. |
PermissionOverwriteTargetType |
type | Overwrite target type: 0 = role, 1 = member. |
@lunibee/rest
Section titled “@lunibee/rest”| Type | Kind | Description |
|---|---|---|
ApplyResponseOptions |
interface | Context for RateLimiter.applyResponse beyond the response itself. |
BucketState |
interface | A rate-limit bucket as stored: units remaining in the window and when it resets (resetAt, ms since the epoch, in the store’s clock). |
BucketUpdate |
interface | What a response said about a bucket, for RateLimitStore.reconcile. |
DecodedError |
interface | Normalised shape of a Discord error payload. |
Grant |
interface | What RateLimiter.acquire obtained. |
MinimalRedisClient |
interface | A Redis client interface that matches the subset of ioredis methods needed for the RedisRateLimitStore. |
RESTDiagnostics |
interface | A REST client’s state, for health checks and diagnostics endpoints. |
RESTFileAttachment |
interface | A file attachment sent as part of a multipart REST request. |
RESTHooks |
interface | Lightweight callback hooks for REST request lifecycle events. |
RESTMetricsSnapshot |
interface | A snapshot of RESTMetrics. |
RESTRateLimitContext |
interface | Context passed to RESTHooks.onRateLimit. |
RESTRequestContext |
interface | Context passed to RESTHooks.onRequest. |
RESTRequestOptions |
interface | Options controlling an individual REST request. |
RESTResponseContext |
interface | Context passed to RESTHooks.onResponse. |
RESTRetryContext |
interface | Context passed to RESTHooks.onRetry. |
RESTTelemetry |
interface | Receives telemetry events. |
RateLimitHeaders |
interface | A response’s rate-limit headers, each one validated on its own. |
RateLimitStore |
interface | Interface for distributed or local rate limit synchronization. |
RedisRateLimitStoreOptions |
interface | Options for RedisRateLimitStore. |
RedisStoreDiagnostics |
interface | The store’s health, for diagnostics endpoints. |
RequestData |
interface | Request options plus files (which upgrade the request to multipart) and, for get() and delete() (which take no positional body), an optional body. |
RequestIdentity |
interface | Who a request’s rate limits belong to. |
ReserveOptions |
interface | Options for RateLimitStore.reserve. |
RetryPolicy |
interface | Configures which REST failures may be retried. |
RouteKey |
interface | Identity of a request as Discord’s rate limiter sees it. |
SchedulerOptions |
interface | Limits for RequestScheduler. |
TransportRequest |
interface | One HTTP attempt, fully resolved: no routing, retry or rate-limit concerns. |
WebhookClientOptions |
interface | Where a WebhookClient sends: a Discord webhook url, or its id and token. |
WebhookMessageOptions |
interface | A webhook message for send() and editMessage(), in Discord’s wire names. |
CoordinationMode |
type | How a store enforces limits right now. |
FetchLike |
type | Minimal fetch shape the transport depends on, so a stub needs no extras. |
RESTErrorCode |
type | One RESTErrorCode value, usable as a type. |
RESTErrorKind |
type | Why a REST request failed, for handling without matching on status codes. |
RESTQuery |
type | Query-string value accepted by a request. |
RESTTelemetryEvent |
type | What the REST pipeline reports while it works. |
RateLimitScope |
type | Which limit a 429 counts against, from X-RateLimit-Scope. |
RedisFailurePolicy |
type | What the store does when Redis cannot be reached. |
Reservation |
type | Outcome of an atomic reservation. |
@lunibee/sharding
Section titled “@lunibee/sharding”| Type | Kind | Description |
|---|---|---|
BroadcastResult |
interface | What a broadcast collected. |
ClusterContext |
interface | What a cluster worker knows about itself. |
ClusterHealth |
interface | Health of one cluster. |
ClusterHostEvents |
interface | What a ClusterHost emits. |
ClusterHostOptions |
interface | Options for a ClusterHost. |
ClusterInfo |
interface | Information about a cluster. |
ClusterManagerEvents |
interface | What ClusterManager emits. |
ClusterManagerHealth |
interface | Health of the whole deployment. |
ClusterManagerOptions |
interface | Configuration for managing multiple shard clusters. |
ClusterPlan |
interface | The result of planClusters. |
ClusterPlanInfo |
interface | What the plan event reports. |
ClusterPlanOptions |
interface | Options for planClusters; set clusterCount or shardsPerCluster, not both. |
GatewayBotInfo |
interface | /gateway/bot information used to pace shard startup. |
HostStatus |
interface | A host as the coordinator sees it. |
IdentifyBudget |
interface | What /gateway/bot says about the session budget. |
IdentifyCoordinatorOptions |
interface | Options for an IdentifyCoordinator. |
IdentifyEvent |
interface | One change in the IDENTIFY queue. |
IdentifyGate |
interface | Asks for the right to IDENTIFY, and gives it back. |
IdentifySlotGate |
interface | An IDENTIFY slot source: a cluster worker’s identifyGate. |
IpcEndpoint |
interface | The part of process (or a child process handle) the IPC transport uses. |
LeaderLock |
interface | Leadership between several coordinators, so a standby ClusterManager can take over when the active one dies. |
LeaderRedisClient |
interface | The part of a Redis client the lock uses. |
RedisLeaderLockOptions |
interface | Options for RedisLeaderLock. |
RemoteOptions |
interface | Where, and how, a coordinator listens for hosts. |
RequestOptions |
interface | Options for a request to a shard or cluster. |
ShardBusOptions |
interface | Options for a ShardBus. |
ShardBusTransport |
interface | Carries ShardMessages between the processes or threads that run shards. |
ShardHealth |
interface | Health snapshot for one shard. |
ShardInfo |
interface | Runtime state for a managed shard. |
ShardManagerEvents |
interface | What ShardManager emits about its shards. |
ShardManagerOptions |
interface | Configuration for a sharded Gateway client. |
ShardMessage |
interface | Message envelope exchanged between Lunibee shards. |
ShardReply |
interface | A reply collected by ShardBus.broadcastRequest. |
SupervisorOptions |
interface | How a crashed cluster is restarted. |
ThreadEndpoint |
interface | The parent link of a cluster thread: the part of process a worker uses. |
ThreadForkOptions |
interface | Options for threadFork. |
WorkerMetrics |
interface | Process numbers a worker adds to a health report. |
WorkerReport |
interface | What a cluster worker reports about itself. |
ClusterCountSource |
type | How planClusters chose the cluster count. |
ClusterState |
type | Lifecycle of a cluster process. |
ShardBusErrorHandler |
type | Listener for errors thrown or rejected by shard message handlers. |
ShardMessageHandler |
type | Handler invoked for shard messages. |
ShardStatus |
type | Where a shard is in its life, apart from the state of its Gateway socket. |
@lunibee/structures
Section titled “@lunibee/structures”| Type | Kind | Description |
|---|---|---|
APIInteractionDataOption |
interface | Raw Discord application command interaction data option. |
AuditLogAutoModInfo |
interface | The rule behind an AutoMod audit entry. |
AuditLogInfoByType |
interface | What info holds for each action type that carries extra details (numbers are parsed from Discord’s strings). |
AuditLogOverwriteInfo |
interface | The overwrite an audit entry is about. |
AuditLogQuery |
interface | Which entries AuditLog.find and AuditLog.filter keep. |
ChannelsByKind |
interface | The class of each channel kind, so channel.is("voice") can narrow to VoiceChannel. |
ComponentCollectorOptions |
interface | Options for Message.createComponentCollector. |
ImageURLOptions |
interface | Options for CDN image URLs. |
InteractionClient |
interface | Transport required by an interaction structure. |
InteractionData |
interface | Data shared by Discord interactions. |
PermissionContext |
interface | Everything needed to resolve a member’s permissions. |
PermissionOverwrite |
interface | A channel permission overwrite (Discord’s permission_overwrites entry). |
PermissionRole |
interface | A role as needed for permission resolution. |
ResourceContext |
interface | What a structure uses to act on Discord (send, edit, fetch, compute permissions). |
AuditLogInfo |
type | The details object of an action type, or undefined when the type has none. |
ChannelOfKind |
type | The channel class for a kind (or a union of them). |
InteractionEnum |
type | One InteractionEnum value, usable as a type. |
PermissionFlagsBits |
type | Union of PermissionFlagsBits values (all bigint). |
PermissionName |
type | A permission flag name, such as "BanMembers", accepted wherever a permission can be given by name. |
PermissionResolvable |
type | Anything accepted as permissions: a bit, a name, a PermissionSet, or an array of these. |
WebhookEnum |
type | One WebhookEnum value, usable as a type. |
@lunibee/types
Section titled “@lunibee/types”| Type | Kind | Description |
|---|---|---|
APIActionRowComponent |
interface | Raw Discord action row component. |
APIActivity |
interface | An activity in a presence (playing, streaming, listening, a custom status…). |
APIApplicationCommand |
interface | Raw Discord application command object (from API). |
APIApplicationCommandOption |
interface | Raw Discord application command option. |
APIAttachment |
interface | Raw Discord attachment object. |
APIAutoModerationAction |
interface | Raw Discord AutoMod action. |
APIAutoModerationActionExecution |
interface | Raw Discord AutoMod action execution event. |
APIAutoModerationRule |
interface | Raw Discord AutoMod rule object. |
APIButtonComponent |
interface | Raw Discord button component. |
APIChannel |
interface | Raw Discord channel object. |
APIChannelDeleteEvent |
interface | Raw Discord channel deletion event payload. |
APIChannelPinsUpdate |
interface | Raw Discord channel pins update event. |
APIEmbed |
interface | Raw Discord embed object. |
APIEmbedAuthor |
interface | Raw Discord embed author object. |
APIEmbedField |
interface | Raw Discord embed field object. |
APIEmbedFooter |
interface | Raw Discord embed footer object. |
APIEmbedMedia |
interface | Raw Discord embed image/thumbnail/video object. |
APIEmbedProvider |
interface | Raw Discord embed provider object. |
APIEmoji |
interface | Raw Discord emoji object. |
APIEntitlement |
interface | Raw Discord entitlement. |
APIError |
interface | Generic Discord API error payload. |
APIForumTag |
interface | Raw Discord forum tag. |
APIGuild |
interface | Raw Discord guild object. |
APIGuildBanEvent |
interface | Raw Discord guild ban event payload. |
APIGuildDeleteEvent |
interface | Raw Discord guild deletion event payload. |
APIGuildEmojisUpdateEvent |
interface | Raw Discord guild emojis update event payload. |
APIGuildMember |
interface | Raw Discord guild member object. |
APIGuildMembersChunk |
interface | Raw Discord guild members chunk event. |
APIGuildOnboarding |
interface | Raw Discord guild onboarding. |
APIGuildRoleDeleteEvent |
interface | Raw Discord guild role delete event payload. |
APIGuildRoleEvent |
interface | Raw Discord guild role event payload. |
APIGuildScheduledEvent |
interface | Raw Discord guild scheduled event object. |
APIGuildScheduledEventEntityMetadata |
interface | Raw Discord guild scheduled event entity metadata. |
APIGuildScheduledEventUserEvent |
interface | Raw Discord guild scheduled event user add/remove event. |
APIGuildStickersUpdateEvent |
interface | Raw Discord guild stickers update event payload. |
APIInviteCreate |
interface | Raw Discord invite create event. |
APIInviteDelete |
interface | Raw Discord invite delete event. |
APIMessage |
interface | Raw Discord message object. |
APIMessageDeleteBulkEvent |
interface | Raw Discord bulk message deletion event payload. |
APIMessageDeleteEvent |
interface | Raw Discord message deletion event payload. |
APIMessagePollVoteEvent |
interface | Raw Discord message poll vote add/remove event. |
APIMessageReaction |
interface | Raw Discord message reaction. |
APIMessageReactionEvent |
interface | Raw Discord reaction event payload. |
APIMessageReactionRemoveEmojiEvent |
interface | Raw Discord reaction remove emoji event payload. |
APIMessageReference |
interface | Raw Discord message reference. |
APIMessageSnapshot |
interface | A forwarded message’s snapshot of the original. |
APIOnboardingOption |
interface | One answer to an onboarding question. |
APIOnboardingPrompt |
interface | A question in a guild’s onboarding. |
APIPartialEmoji |
interface | Raw Discord emoji (partial, as used in components). |
APIPoll |
interface | Raw Discord poll object. |
APIPresenceUpdate |
interface | Raw Discord presence update event. |
APIReadyEvent |
interface | Raw Discord READY event payload. |
APIRole |
interface | Raw Discord role object. |
APIRoleColors |
interface | A role’s colours: a solid colour, or a gradient or holographic style. |
APISKU |
interface | Raw Discord SKU. |
APISelectMenuComponent |
interface | Raw Discord select menu component. |
APISelectMenuOption |
interface | Raw Discord select menu option. |
APISoundboardSound |
interface | Raw Discord soundboard sound. |
APIStageInstance |
interface | Raw Discord stage instance object. |
APISticker |
interface | Full Discord sticker object. |
APIStickerItem |
interface | Compact sticker item as included in messages. |
APISubscription |
interface | Raw Discord subscription. |
APITextInputComponent |
interface | Raw Discord text input component. |
APIThreadEvent |
interface | Raw Discord thread lifecycle payload. |
APIThreadListSync |
interface | Raw Discord thread list sync event. |
APIThreadMember |
interface | Raw Discord thread member. |
APIThreadMembersUpdate |
interface | Raw Discord thread members update event. |
APIThreadMetadata |
interface | Raw Discord thread metadata. |
APITypingStart |
interface | Raw Discord typing start event. |
APIVoiceServerUpdate |
interface | Raw Discord voice server update event. |
APIVoiceState |
interface | Raw Discord voice state object. |
APIWebhook |
interface | Raw Discord webhook object. |
APIWebhooksUpdate |
interface | Raw Discord webhooks update event. |
APIWelcomeScreen |
interface | Raw Discord welcome screen. |
APIWelcomeScreenChannel |
interface | A channel shown on the welcome screen. |
ApplicationCommandData |
interface | Data for creating/overwriting an application command. |
ClientOptions |
interface | Client configuration. |
ForumTagInput |
interface | Fields for a forum or media channel tag. |
GatewayPayload |
interface | Discord Gateway payload envelope. |
GatewayPresence |
interface | Gateway presence data. |
GatewayPresenceActivity |
interface | Gateway presence activity. |
GatewayProperties |
interface | Gateway connection properties (OS, browser, device). |
InteractionReplyOptions |
interface | What a reply, edit-reply, follow-up or update to an interaction takes. |
MessageCreateOptions |
interface | What send() takes. |
MessageEditOptions |
interface | What edit() takes: the fields Discord lets you change after sending. |
MessageFile |
interface | A file to upload with a message. |
MessagePoll |
interface | A poll to send; Discord fills in results and expiry when it is read back. |
RESTOptions |
interface | REST request configuration. |
UserData |
interface | Discord user object. |
APIMessageActionRowComponent |
type | Union of all raw message component types. |
APIMessageComponent |
type | Union including action rows and V2 components. |
ActivityEnum |
type | One ActivityEnum value, usable as a type. |
ApplicationCommandEnum |
type | One ApplicationCommandEnum value, usable as a type. |
ApplicationCommandOptionEnum |
type | One ApplicationCommandOptionEnum value, usable as a type. |
ButtonType |
type | One ButtonType value, usable as a type: style: ButtonType. |
ChannelEnum |
type | One ChannelEnum value, usable as a type. |
ChannelKind |
type | The name of a kind of channel, such as "text" or "voice". |
ComponentEnum |
type | One ComponentEnum value, usable as a type. |
GatewayIntentResolvable |
type | Gateway intents: an array of intent bits or names, e.g. |
InteractionResponseEnum |
type | One InteractionResponseEnum value, usable as a type. |
MessageFlags |
type | One MessageFlags value, usable as a type. |
Snowflake |
type | Discord API snowflake identifier. |
StickerEnum |
type | One StickerEnum value, usable as a type. |
StickerFormatEnum |
type | One StickerFormatEnum value, usable as a type. |
UnknownChannelKind |
type | A channel type Discord has no kind for yet. |
@lunibee/utils
Section titled “@lunibee/utils”| Type | Kind | Description |
|---|---|---|
MentionableArg |
interface | A mentionable argument: which kind of mention it was. |
PrefixArgSpec |
interface | One expected argument. |
PrefixArgType |
type | What an argument is read as. |
PrefixArgValue |
type | A parsed prefix-command argument: a string, number, boolean or mention. |
PrefixArgsResult |
type | The result of parsePrefixArgs: the parsed values, or the argument that failed and why. |
@lunibee/voice
Section titled “@lunibee/voice”| Type | Kind | Description |
|---|---|---|
AudioEffect |
interface | A PCM effect: changes one 20 ms frame of 48 kHz stereo interleaved samples in place. |
AudioPlayerEvents |
interface | What AudioPlayer emits. |
AudioPlayerOptions |
interface | Options for AudioPlayer. |
AudioResourceOptions |
interface | Options for createAudioResource. |
AudioSink |
interface | A destination for a player’s frames: a voice connection. |
DaveSessionHooks |
interface | What a DaveSession asks its connection to send. |
DisconnectReason |
interface | Why a connection is disconnected. |
EchoOptions |
interface | Options for echo. |
JoinVoiceChannelOptions |
interface | Options for joinVoiceChannel. |
OpusCodec |
interface | One 48 kHz stereo Opus encoder and decoder. |
PlayerSubscription |
interface | A player subscribed to a connection. |
ReceiveOptions |
interface | Options for VoiceReceiver.subscribe. |
RecordOptions |
interface | Options for VoiceReceiver.record. |
RtpHeader |
interface | A parsed RTP packet header. |
UdpSocketLike |
interface | The parts of a UDP socket VoiceUdp uses; Bun.udpSocket provides them. |
VoiceAdapter |
interface | How a connection reaches the main Gateway: send op 4, and be told about voice events. |
VoiceAdapterMethods |
interface | What a connection gives its adapter. |
VoiceBinaryPacket |
interface | A binary voice gateway frame (DAVE): sequence, opcode and payload. |
VoiceConnectionEvents |
interface | What a VoiceConnection emits. |
VoiceGatewayHandlers |
interface | What a VoiceGateway reports to its owner. |
VoiceManagerClient |
interface | What a VoiceManager needs from its client. |
VoiceNetworkingHandlers |
interface | What a VoiceNetworking reports. |
VoiceNetworkingOptions |
interface | Options for VoiceNetworking. |
VoicePacket |
interface | A JSON voice gateway frame. |
VoiceServerData |
interface | VOICE_SERVER_UPDATE. |
VoiceServerInfo |
interface | What Discord sent for one voice session (VOICE_STATE_UPDATE + VOICE_SERVER_UPDATE). |
VoiceSocketLike |
interface | The parts of a WebSocket VoiceGateway uses; the global WebSocket provides them. |
VoiceStateData |
interface | The bot’s own VOICE_STATE_UPDATE, as the adapter forwards it. |
VoiceStatePayload |
interface | An op 4 (Voice State Update) payload. |
AudioInput |
type | What createAudioResource can play. |
AudioPlayerStatus |
type | Where an AudioPlayer is. |
NetworkingState |
type | Where a VoiceNetworking is in its handshake. |
OpusApplication |
type | OPUS_APPLICATION_*: what the encoder tunes for. |
ReceiveEnd |
type | When a VoiceReceiver.subscribe stream ends. |
StreamType |
type | What an input holds: - "arbitrary": any format FFmpeg reads (needs ffmpeg on the PATH); - "ogg/opus": an Ogg/Opus file or stream, played without re-encoding; - "opus": one Opus packet (20 ms) per chunk; - "raw": 48 kHz stereo s16le PCM (needs an Opus library). |
UdpSocketFactory |
type | Opens a UDP socket that calls onData for each datagram. |
VoiceAdapterCreator |
type | Builds an adapter for a guild. |
VoiceCloseCodes |
type | Voice gateway close codes. |
VoiceConnectionStatus |
type | Where a VoiceConnection is. |
VoiceEncryptionMode |
type | Transport encryption modes this package implements. |
VoiceJoinOptions |
type | Options for VoiceManager.join. |
VoiceOpcodes |
type | Voice gateway opcodes (v8, with the DAVE opcodes 21-31). |
VoiceSocketFactory |
type | Opens a WebSocket. |
@lunibee/ws
Section titled “@lunibee/ws”| Type | Kind | Description |
|---|---|---|
GatewayDecoder |
interface | Decodes transport data into complete frames. |
GatewayHealth |
interface | What Gateway.health reports. |
GatewayOptions |
interface | Gateway connection configuration. |
HeartbeatOptions |
interface | Collaborators the heartbeat needs from its owner. |
IdentifyData |
interface | The d field of an IDENTIFY payload. |
IdentifyOptions |
interface | Everything IDENTIFY needs. |
IdentifyProperties |
interface | Identification properties sent with IDENTIFY. |
ProtocolResult |
interface | A classified frame: its sequence, if any, and what it means. |
ReconnectOptions |
interface | Configuration for GatewayReconnect. |
ResumeInfo |
interface | Everything needed to send a RESUME, or nothing when one is impossible. |
TransportHandlers |
interface | Callbacks a transport reports to its owner. |
TransportOptions |
interface | Configuration for WebSocketTransport. |
CloseAction |
type | What a closed connection should do next. |
GatewayAction |
type | What a received frame means. |
GatewayListener |
type | Gateway event listener. |
HandshakeIntent |
type | What the next connection must do. |
HeartbeatTimeout |
type | Why the connection was declared dead. |
InvalidationReason |
type | Why a session was discarded. |
ProtocolViolation |
type | Why a frame could not be understood. |
ScheduleRefusal |
type | Why a reconnect was not scheduled. |
ScheduleResult |
type | Outcome of asking for a reconnect. |
SocketFactory |
type | Creates the underlying socket. |