website·Indexed 33 days ago
https://www.sapphirejs.dev/API documentation for the Sapphire framework, including core pieces, framework resolvers, and various plugins such as @sapphire/plugin-scheduled-tasks, @sapphire/plugin-pattern-commands, @sapphire/plugin-api, and @sapphire/plugin-subcommands.
Option<T, Exists> class represents an optional value: it either contains a value of type T (Some) or contains no value (None). It uses a type parameter Exists (boolean) to track whether a value is present at the type level.The @sapphire/result library provides a TypeScript port of Nightly Rust's Result<T, E> and Option<T> structs.
Result: A type union used to express computations that can fail. It consists of two variants: Ok(T) (representing success and containing a value) and Err(E) (representing error and containing an error value).Option: A type used to represent a value that may or may not be present.@sapphire/async-queue is a sequential asynchronous lock-based queue for promises. It is written in TypeScript, bundled with esbuild for compatibility with both Node.js and browsers, and provides CommonJS, ESM, and UMD bundles.@sapphire/plugin-api provides an API endpoint for a bot that can be called from external services. This is particularly useful for creating a web dashboard where end-users can modify bot configuration settings via a website that interfaces with the bot.@sapphire/result package is a TypeScript port of Nightly Rust's Result<T, E> and Option<T> structs. It is designed to alleviate the chaos of nested or sequential try-catch blocks by providing a functional way to express computations that can fail, propagate errors, and handle optional values.TimerManager class manages timers (timeouts and intervals) so that an application can be cleanly exited. It tracks all timers created through its static methods and provides a mechanism to clear them all at once.CommandStore class is used to store and manage all Command pieces within the Sapphire framework. It extends AliasStore<Command, "commands"> and has been available since version 1.0.0.The @sapphire/plugin-utilities-store plugin for the Sapphire framework provides an automatically imported utilities store. This allows developers to centralize external utility functions and access them through the Sapphire container.
Important Constraint: Utility functions are only available on the container after the bot has logged in. Any functions required during the pre-login phase must be exported using standard module loading (e.g., export / require).