Skip to main content

Class reference

This reference covers all 35 classes exported by the package. Each entry explains how to obtain an instance, its properties, and its methods. The four implementation classes are documented separately under internals. In the import column, /rest means talos-fluxer/rest, and the other shortened subpaths work the same way. Voice, shards, workers, and Node adapters require their listed subpaths; they are not re-exported from the main entry point.

Reading the method tables

options? means optional. For REST-backed operations it generally accepts signal, timeoutMs, and reason; message sends and edits also accept files. Request bodies and query objects use the bundled API schema. Follow each page’s source link or use editor completion for the exact fields. Event-emitting classes also expose on(), once(), emit(), and removeAllListeners(). These inherited methods are described under TypedEmitter. Resource snapshots inherit data and toJSON() from Resource. Start with the command-bot guide for a complete program, or return to the docs index for task-specific examples.