Sapphire

https://sapphirejs.dev/docs/
Admin
Sapphire is a next-gen, object-oriented Discord.js bot framework designed to provide a modern,...
Tokens:559,556
Snippets:4,106
Trust Score:7.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Initialize Sapphire Project

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Run this command in your terminal to start the interactive project setup wizard.

```bash
sapphire init
```

--------------------------------

### GET /hello

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-api/classes/Route

Example of a simple GET route implementation.

```APIDOC
## GET /hello

### Description
A basic route that returns a 'Hello, World!' message.

### Method
GET

### Response
#### Success Response (200)
- **message** (string) - The greeting message.

#### Response Example
{
  "message": "Hello, World!"
}
```

--------------------------------

### Install @sapphire/discord-utilities

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/discord-utilities

Use this command to install the package. Replace `npm install` with your preferred package manager.

```bash
npm install @sapphire/discord-utilities
```

--------------------------------

### Install @sapphire/plugin-subcommands

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-subcommands

Install the plugin and its dependencies using npm. Ensure you have @sapphire/framework, @sapphire/utilities, and discord.js installed.

```bash
npm install @sapphire/plugin-subcommands @sapphire/framework @sapphire/utilities discord.js  
```

--------------------------------

### Install @sapphire/fetch with yarn

Source: https://sapphirejs.dev/docs/Guide/utilities/fetch

Install the @sapphire/fetch package using yarn.

```bash
yarn add @sapphire/fetch  
```

--------------------------------

### Install @sapphire/ratelimits

Source: https://sapphirejs.dev/docs/Guide/utilities/ratelimits

Install the package using your preferred package manager.

```bash
npm install @sapphire/ratelimits
```

```bash
yarn add @sapphire/ratelimits
```

```bash
pnpm add @sapphire/ratelimits
```

--------------------------------

### Install @sapphire/ratelimits

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/ratelimits

Command to install the package via npm.

```bash
npm install @sapphire/ratelimits  
```

--------------------------------

### Install Sapphire Framework with pnpm

Source: https://sapphirejs.dev/docs/General/Welcome

Install the core Sapphire framework and Discord.js using pnpm. Ensure Node.js 18.x or newer is installed.

```bash
pnpm add @sapphire/framework discord.js@14.x  

```

--------------------------------

### Install @sapphire/async-queue

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/async-queue

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/async-queue  

```

--------------------------------

### Install @sapphire/time-utilities

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/time-utilities

Command to install the package using npm.

```bash
npm install @sapphire/time-utilities
```

--------------------------------

### Install @sapphire/fetch

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/fetch

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/fetch  
```

--------------------------------

### Install @sapphire/fetch with pnpm

Source: https://sapphirejs.dev/docs/Guide/utilities/fetch

Install the @sapphire/fetch package using pnpm.

```bash
pnpm add @sapphire/fetch  
```

--------------------------------

### Install @sapphire/time-utilities with pnpm

Source: https://sapphirejs.dev/docs/Guide/utilities/time-utilities

Install the package using pnpm.

```bash
pnpm add @sapphire/time-utilities  
```

--------------------------------

### Install Sapphire Framework with yarn

Source: https://sapphirejs.dev/docs/General/Welcome

Install the core Sapphire framework and Discord.js using yarn. Ensure Node.js 18.x or newer is installed.

```bash
yarn add @sapphire/framework discord.js@14.x  

```

--------------------------------

### Install @sapphire/timer-manager

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/timer-manager

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/timer-manager  
```

--------------------------------

### Install @sapphire/utilities

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/utilities

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/utilities  
```

--------------------------------

### Install @sapphire/plugin-utilities-store

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-utilities-store

Command to install the plugin via npm.

```bash
npm install @sapphire/plugin-utilities-store
```

--------------------------------

### Configure package.json for HMR

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-hmr

Example scripts configuration to enable HMR by running build and start processes in parallel.

```json
"scripts": {  
	"dev": "run-p watch start",  
	"build": "tsc",  
	"watch": "tsc --watch",  
	"start": "node dist/index.js"  
}
```

--------------------------------

### Install @sapphire/time-utilities with yarn

Source: https://sapphirejs.dev/docs/Guide/utilities/time-utilities

Install the package using yarn.

```bash
yarn add @sapphire/time-utilities  
```

--------------------------------

### Install @sapphire/plugin-pattern-commands

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-pattern-commands

Use this command to install the plugin along with its required dependencies.

```bash
npm install @sapphire/plugin-pattern-commands @sapphire/framework @sapphire/utilities @sapphire/stopwatch discord.js
```

--------------------------------

### Install @sapphire/stopwatch

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/stopwatch

Command to install the package via npm.

```bash
npm install @sapphire/stopwatch
```

--------------------------------

### Install @sapphire/event-iterator

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/event-iterator

Command to install the package via npm.

```bash
npm install @sapphire/event-iterator
```

--------------------------------

### Install @sapphire/result

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/result

Command to install the package via npm.

```bash
npm install @sapphire/result
```

--------------------------------

### Install Sapphire and discord.js

Source: https://sapphirejs.dev/docs/Guide/getting-started/getting-started-with-sapphire

Commands to install the necessary dependencies using different package managers.

```bash
npm install @sapphire/framework discord.js@14.x
```

```bash
yarn add @sapphire/framework discord.js@14.x
```

```bash
pnpm add @sapphire/framework discord.js@14.x
```

--------------------------------

### Install @sapphire/duration

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/duration

Command to install the package via npm.

```bash
npm install @sapphire/duration
```

--------------------------------

### Install @sapphire/timestamp

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/timestamp

Command to install the package via npm.

```bash
npm install @sapphire/timestamp
```

--------------------------------

### Install @sapphire/string-store

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/string-store

Install the package using npm. This command can be replaced with your preferred package manager.

```bash
npm install @sapphire/string-store  

```

--------------------------------

### Install @sapphire/phisherman

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/phisherman

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/phisherman  
```

--------------------------------

### Install @sapphire/node-utilities

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/node-utilities

Install this package using npm or your preferred package manager.

```bash
npm install @sapphire/node-utilities
```

--------------------------------

### Install @sapphire/iterator-utilities

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/iterator-utilities

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/iterator-utilities
```

--------------------------------

### Install @sapphire/plugin-scheduled-tasks

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-scheduled-tasks

Command to install the plugin and its required dependency.

```bash
npm install @sapphire/plugin-scheduled-tasks @sapphire/framework
```

--------------------------------

### Install @sapphire/plugin-i18next

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-i18next

Command to install the plugin along with its required dependencies.

```bash
npm install @sapphire/plugin-i18next @sapphire/framework discord.js
```

--------------------------------

### Install Plugin Editable Commands

Source: https://sapphirejs.dev/docs/Guide/plugins/plugin-editable-commands

Install the plugin and the framework dependency using your preferred package manager.

```bash
npm install @sapphire/plugin-editable-commands @sapphire/framework
```

```bash
yarn add @sapphire/plugin-editable-commands @sapphire/framework
```

```bash
pnpm add @sapphire/plugin-editable-commands @sapphire/framework
```

--------------------------------

### Example usage of fullCategory

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-subcommands/interfaces/SubcommandOptions

Examples showing how to define the fullCategory path based on file structure.

```typescript
// Given a file named `ping.js` at the path of `commands/General/ping.js`  
['General']  
  
// Given a file named `info.js` at the path of `commands/General/About/info.js`  
['General', 'About']
```

--------------------------------

### Function: start()

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-hmr/functions/start

Starts HMR for all registered Store Stores in the main container.

```APIDOC
## Function: start()

### Description
Starts HMR for all registered Store Stores in the main container.

### Method
N/A (This is a function definition, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
`void`

#### Response Example
None
```

--------------------------------

### Install @sapphire/type

Source: https://sapphirejs.dev/docs/Documentation/api-type

Commands to install the package using yarn or npm.

```bash
yarn add @sapphire/type  
# npm install @sapphire/type  
```

--------------------------------

### Install @sapphire/plugin-api

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-api

Install the @sapphire/plugin-api package along with its dependencies using npm.

```bash
npm install @sapphire/plugin-api @sapphire/framework discord.js discord-api-types  

```

--------------------------------

### Install @sapphire/plugin-logger

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-logger

Command to install the logger plugin and its required framework dependency.

```bash
npm install @sapphire/plugin-logger @sapphire/framework
```

--------------------------------

### Install @sapphire/bitfield

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/bitfield

Install the package using npm or your preferred package manager.

```bash
npm install @sapphire/bitfield  

```

--------------------------------

### Install @sapphire/snowflake

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/snowflake

Use this command to install the package via npm.

```bash
npm install @sapphire/snowflake
```

--------------------------------

### Install @sapphire/decorators and dependencies

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/decorators

Use this command to install the package along with its required peer dependencies.

```bash
npm install @sapphire/decorators @sapphire/discord.js-utilities @sapphire/utilities @sapphire/framework discord.js
```

--------------------------------

### Install @sapphire/lexure

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/lexure

Use npm to install the @sapphire/lexure package. This command can be replaced with your preferred package manager.

```bash
npm install @sapphire/lexure  

```

--------------------------------

### Install Sapphire Plugin API with yarn

Source: https://sapphirejs.dev/docs/Guide/plugins/API/getting-started

Use this command to install the necessary packages for the Sapphire Plugin API using yarn.

```bash
yarn add @sapphire/plugin-api @sapphire/framework discord.js@14.x discord-api-types@0.37.x  

```

--------------------------------

### Install Sapphire CLI globally

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Use these commands to install the Sapphire CLI globally on your system.

```shell
npm install -g @sapphire/cli
```

```shell
pnpm add -g @sapphire/cli
```

```shell
yarn dlx @sapphire/cli
```

```shell
volta install @sapphire/cli
```

--------------------------------

### Initialize and Use SchemaStore

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/string-store

Demonstrates how to require the store classes, define an enum for IDs, create a SchemaStore instance, and add schemas for different data types. It also shows how to serialize an object into a string.

```javascript
// Require the store classes  
const { SchemaStore, Schema, t } = require('@sapphire/string-store');  
  
// Define the enum with the IDs and export it  
export const Id = Object.freeze({
	AgeUpdate: 0,
	StrengthUpdate: 1,
	Planet: 2,
	User: 3
});  
  
// Create the store in a file and export it  
export const store = new SchemaStore()
	// Add a schema with an age field stored as a int32:  
	// Schema<Id.AgeUpdate, { age: number }>
	.add(new Schema(Id.AgeUpdate).int32('age'))  
	// Add a schema with a strength field stored as a float32:  
	// Schema<Id.StrengthUpdate, { strength: number }>
	.add(new Schema(Id.StrengthUpdate).float32('strength'));  
  
// Serialize an `Id.AgeUpdate` object into a string containing:  
// - The schema ID (0)
// - The age field (20)
const buffer = store.serialize(Id.AgeUpdate, { age: 20 }).toString();  

```

--------------------------------

### Install Editable Commands Plugin

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-editable-commands

Install the @sapphire/plugin-editable-commands and @sapphire/framework packages using npm.

```bash
npm install @sapphire/plugin-editable-commands @sapphire/framework  
```

--------------------------------

### Interval Task Example

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-scheduled-tasks

An example demonstrating how to create and configure an interval task that runs at a specified frequency.

```APIDOC
## Creating an Interval Task

### Description
This example shows how to define a custom task that executes at a regular interval.

### Method
N/A (Class Definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Code Example
```typescript
import { ScheduledTask } from '@sapphire/plugin-scheduled-tasks';

export class IntervalTask extends ScheduledTask {
	public constructor(context: ScheduledTask.LoaderContext, options: ScheduledTask.Options) {
		super(context, {
			...options,
			interval: 60_000 // 60 seconds
		});
	}

	public async run() {
		this.container.logger.info('I run every minute');
	}
}

declare module '@sapphire/plugin-scheduled-tasks' {
	interface ScheduledTasks {
		interval: never;
	}
}
```
```

--------------------------------

### Install Sapphire Plugin API with pnpm

Source: https://sapphirejs.dev/docs/Guide/plugins/API/getting-started

Use this command to install the necessary packages for the Sapphire Plugin API using pnpm.

```bash
pnpm add @sapphire/plugin-api @sapphire/framework discord.js@14.x discord-api-types@0.37.x  

```

--------------------------------

### Install @sapphire/cron

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/cron

Use this command to install the package via npm or your preferred package manager.

```bash
npm install @sapphire/cron
```

--------------------------------

### Get Union Type of Array Elements

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/utilities/type-aliases/ArrayElementType

Use ArrayElementType<T> to get a union type of all elements in an array. This example shows how to infer the types from a mixed-type array.

```typescript
const sample = [1, 2, '3', true];
  
type arrayUnion = ArrayElementType<typeof sample>;
// Expected: string | number | boolean  
```

--------------------------------

### Configure package.json

Source: https://sapphirejs.dev/docs/Guide/getting-started/getting-started-with-sapphire

Example of a package.json file with the required main entry point and dependencies.

```json
{
  "name": "my-awesome-new-bot",
  "main": "src/index.js",
  "dependencies": {
    "@sapphire/framework": "latest",
    "discord.js": "14.x"
  },
  "scripts": {
    "start": "node src/index.js"
  }
}
```

--------------------------------

### Install Sapphire Framework and Discord.js

Source: https://sapphirejs.dev/docs/Documentation/api-framework

Install the Sapphire framework and discord.js v14.x using npm. Ensure discord.js is at version 14.x as required by the framework.

```bash
npm install @sapphire/framework discord.js@14.x  

```

--------------------------------

### Project Creation Complete

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

After completing the prompts, the CLI will create your project and install dependencies. This process may take a few minutes.

```bash
sapphire new  
√ What's the name of your project? ... my-sapphire-bot  
√ Choose a language for your project » TypeScript (Recommended)  
√ Choose a template for your project » Default template (Recommended)  
√ What format do you want your config file to be in? » YAML  
√ What package manager do you want to use? » Yarn (Recommended)  
√ Do you want to use Yarn v3? ... yes  
√ Do you want to create a git repository for this project? ... yes  
✔ Cloning the repository  
✔ Setting up the project  
✔ Initializing git repo  
✔ Installing Yarn v3  
✔ Installing Yarn Typescript Plugin  
✔ Installing dependencies using Yarn  
Done!  
```

--------------------------------

### Cron Class - Get Next Execution (CommonJS)

Source: https://sapphirejs.dev/docs/Guide/utilities/time-utilities

Use the Cron class to parse cron strings and determine the next execution time. This example uses CommonJS.

```javascript
const { Cron } = require('@sapphire/time-utilities');  

const cronTime = new Cron('0 * * * *');  

console.log(cronTime.next());  
// logs next hour time  

console.log(cronTime.next(new Date('2022-04-24T19:30:00Z')));  
// 2022-04-24T20:00:00.000Z  
```

--------------------------------

### setUpMessage()

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/discord.js-utilities/classes/PaginatedMessageEmbedFields

Sets up the message.

```APIDOC
## setUpMessage()

### Description
Sets up the message.

### Parameters
- **messageOrInteraction** (Message<boolean> | AnyInteractableInteraction) - Required - The message or interaction that triggered this PaginatedMessage.

### Returns
- **Promise<void>**
```

--------------------------------

### Fetch Language using TypeScript

Source: https://sapphirejs.dev/docs/Guide/plugins/i18next/getting-started

A TypeScript example showing how to retrieve the language code for various interaction types. Ensure you have the necessary Sapphire.js packages and TypeScript types installed.

```typescript
import { fetchLanguage } from '@sapphire/plugin-i18next';
import { Command } from '@sapphire/framework';

export class PingCommand extends Command {
  public constructor(context: Command.LoaderContext, options: Command.Options) {
    super(context, {
      ...options,
      description: 'ping pong'
    });
  }

  public override async messageRun(message: Message) {
    const languageCodeForCurrentGuild = await fetchLanguage(message);
    // ===> en-US
  }

  public override async chatInputRun(interaction: Command.ChatInputCommandInteraction) {
    const languageCodeForCurrentGuild = await fetchLanguage(interaction);
    // ===> en-US
  }

  public override async contextMenuRun(interaction: Command.ContextMenuCommandInteraction) {
    const languageCodeForCurrentGuild = await fetchLanguage(interaction);
    // ===> en-US
  }
}
```

--------------------------------

### setUpMessage()

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/discord.js-utilities/classes/PaginatedMessage

Sets up the message.

```APIDOC
## setUpMessage()

### Description
Sets up the message.

### Method
`setUpMessage`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **messageOrInteraction** (Message<boolean> | AnyInteractableInteraction) - Required - The message or interaction that triggered this PaginatedMessage. Generally this will be the command message or an interaction (either a CommandInteraction, ContextMenuInteraction, or an interaction from PaginatedMessageInteractionUnion), but it can also be another message from your client, i.e. to indicate a loading state.

### Request Example
```json
{
  "messageOrInteraction": "<message_or_interaction_object>"
}
```

### Response
#### Success Response (200)
- **Promise<void>** - This method returns a promise that resolves when the message setup is complete.

#### Response Example
```json
{
  "message": "Message setup complete"
}
```
```

--------------------------------

### GET Buffer Data (Images, etc.) with SapphireJS Fetch

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/fetch

This example demonstrates how to fetch binary data, such as images or files, using the fetch method. The result is returned as a Buffer.

```typescript
import { SapphireClient } from "@sapphire/framework";

const client = new SapphireClient({
    intents: ["GuildMessages"]
});

client.fetch<Buffer>("https://example.com/image.png").then(data => {
    console.log(data);
});
```

--------------------------------

### Cron Class - Get Next Execution (ESM)

Source: https://sapphirejs.dev/docs/Guide/utilities/time-utilities

Use the Cron class to parse cron strings and determine the next execution time. This example uses ECMAScript Modules (ESM).

```javascript
import { Cron } from '@sapphire/time-utilities';  

const cronTime = new Cron('0 * * * *');  

console.log(cronTime.next());  
// logs next hour time  

console.log(cronTime.next(new Date('2022-04-24T19:30:00Z')));  
// 2022-04-24T20:00:00.000Z  
```

--------------------------------

### Server Constructor

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-api/classes/Server

Initializes a new Server instance with the provided options.

```APIDOC
## Constructor: Server

### Description
Initializes a new Server instance.

### Method
`new Server(options: ServerOptions)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "options": { ... } 
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Conditional Type Branching with If Utility

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/utilities/type-aliases/If

Demonstrates how to use the If type utility for conditional type assignment. The 'get' function returns a string if 'getValues' is true, and a string array otherwise. The example shows type inference for explicit boolean inputs and a general boolean.

```typescript
declare function get<const GetValues extends boolean = false>(
  getValues?: GetValues
): If<GetValues, string, string[]>;

const a = get(true);
//    ^? string

const b = get(false);
//    ^? string[]

declare const someBoolean: boolean;
const c = get(someBoolean);
//    ^? string | string[]
```

--------------------------------

### Contribution Guide

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/duration

Guidelines for contributing to the Sapphire.js project.

```APIDOC
## Contributing to Sapphire.js

Please read the [Contributing Guide](link-to-contributing-guide) before making a pull request. Thank you to all who have contributed!
```

--------------------------------

### Example Application Command Object

Source: https://sapphirejs.dev/docs/Guide/commands/application-commands/application-command-registry/advanced/routing-existing-application-commands-to-a-command

This is an example of an Application Command Object as managed by Discord. You will use the 'id' or 'name' fields from these objects to route commands.

```json
{
  "id": "1223334444555554444",
  "application_id": "...",
  // ...
  "name": "foo",
  "description": "bar!"
}
```

--------------------------------

### Choose Project Template

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Select a template for your project. Options include the default template, or templates with Docker, tsup, or SWC.

```bash
sapphire new  
√ What's the name of your project? ... my-sapphire-bot  
√ Choose a language for your project » TypeScript (Recommended)  
? Choose a template for your project » - Use arrow-keys. Return to submit.  
>   Default template (Recommended)  
    with Docker  
    with tsup  
    with SWC  
```

--------------------------------

### SapphireClient Initialization

Source: https://sapphirejs.dev/docs/Documentation/api-framework/classes/SapphireClient

Demonstrates how to initialize the SapphireClient with different configuration options, including presence, automatic scanning, and opting out of scanning.

```APIDOC
## Initialization Examples

### Basic Initialization
```typescript
const client = new SapphireClient({
  presence: {
    activity: {
      name: 'for commands!',
      type: 'LISTENING'
    }
  }
});

client.login(process.env.DISCORD_TOKEN)
  .catch(console.error);
```

### Automatic Scanning from a Specific Directory
```typescript
import { join } from 'path';

const client = new SapphireClient({
  baseUserDirectory: join(__dirname, 'pieces'),
  // More options...
});
```

### Opt-out of Automatic Scanning
```typescript
const client = new SapphireClient({
  baseUserDirectory: null,
  // More options...
});
```
```

--------------------------------

### Initialize New Sapphire Project

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Run the 'sapphire new' command to start the project creation process. You will be prompted for various configuration details.

```bash
sapphire new  
```

--------------------------------

### Install @sapphire/discord.js-utilities

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/discord.js-utilities

Install the package along with its required dependency discord.js.

```bash
npm install @sapphire/discord.js-utilities discord.js
```

--------------------------------

### Initialize SapphireClient

Source: https://sapphirejs.dev/docs/Guide/getting-started/getting-started-with-sapphire

Instantiate the SapphireClient with required intents to handle bot setup and login.

```CommonJS
const { SapphireClient } = require('@sapphire/framework');  
const { GatewayIntentBits } = require('discord.js');  
  
const client = new SapphireClient({ intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages] });  
  
client.login('your-token-goes-here');  
```

```ESM
import { SapphireClient } from '@sapphire/framework';  
import { GatewayIntentBits } from 'discord.js';  
  
const client = new SapphireClient({ intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages] });  
  
client.login('your-token-goes-here');  
```

```TypeScript
import { SapphireClient } from '@sapphire/framework';  
import { GatewayIntentBits } from 'discord.js';  
  
const client = new SapphireClient({ intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages] });  
  
client.login('your-token-goes-here');  
```

--------------------------------

### Project directory structure

Source: https://sapphirejs.dev/docs/Guide/getting-started/creating-a-basic-command

Example of the expected file structure for a Sapphire project with a commands directory.

```text
├── node_modules  
├── package.json  
└── src  
    ├── commands  
    │   └── ping.js  
    └── index.js  
```

--------------------------------

### Install @sapphire/plugin-hmr

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-hmr

Command to install the plugin along with its required dependency.

```bash
npm install @sapphire/plugin-hmr @sapphire/framework
```

--------------------------------

### Initialize Sapphire CLI

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Run the 'init' command to start the Sapphire CLI initialization process in your project.

```bash
sapphire init  
```

--------------------------------

### Choose Configuration File Format (YAML)

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Select YAML as the format for your configuration file during Sapphire CLI initialization.

```bash
sapphire init  
? What format do you want your config file to be in? » - Use arrow-keys. Return to submit.  
    JSON  
>   YAML  
```

--------------------------------

### Debug Log Example

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-logger

Example of triggering a debug log message.

```typescript
container.logger.debug('log debug message');
```

--------------------------------

### Constructor: new UtilitiesStore()

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-utilities-store/classes/UtilitiesStore

Initializes a new instance of the UtilitiesStore class.

```APIDOC
## Constructor

### Description
Creates a new instance of the UtilitiesStore class.

### Method
NEW

### Endpoint
new UtilitiesStore()

### Returns
- **UtilitiesStore** - A new instance of the UtilitiesStore class.
```

--------------------------------

### Register a User Context Menu Command

Source: https://sapphirejs.dev/docs/Guide/commands/application-commands/application-command-registry/registering-context-commands

Implementation examples for CommonJS, ESM, and TypeScript environments.

```javascript
const { Command } = require('@sapphire/framework');  
const { ApplicationCommandType } = require('discord.js');  
  
class SlashCommand extends Command {  
  constructor(context, options) {  
    super(context, {  
      ...options,  
      description: 'Ban user.'  
    });  
  }  
  
  registerApplicationCommands(registry) {  
    registry.registerContextMenuCommand((builder) =>  
      builder //  
        .setName(this.name)  
        .setType(ApplicationCommandType.User)  
    );  
  }  
  
  contextMenuRun(interaction) {  
    // ...  
  }  
}  
module.exports = {  
  SlashCommand  
};
```

```javascript
import { Command } from '@sapphire/framework';  
import { ApplicationCommandType } from 'discord.js';  
  
export class SlashCommand extends Command {  
  constructor(context, options) {  
    super(context, {  
      ...options,  
      description: 'Ban user.'  
    });  
  }  
  
  registerApplicationCommands(registry) {  
    registry.registerContextMenuCommand((builder) =>  
      builder //  
        .setName(this.name)  
        .setType(ApplicationCommandType.User)  
    );  
  }  
  
  contextMenuRun(interaction) {  
    // ...  
  }  
}
```

```typescript
import { Command } from '@sapphire/framework';  
import { ApplicationCommandType } from 'discord.js';  
  
export class SlashCommand extends Command {  
  public constructor(context: Command.LoaderContext, options: Command.Options) {  
    super(context, {  
      ...options,  
      description: 'Ban user.'  
    });  
  }  
  
  public override registerApplicationCommands(registry: Command.Registry) {  
    registry.registerContextMenuCommand((builder) =>  
      builder //  
        .setName(this.name)  
        .setType(ApplicationCommandType.User)  
    );  
  }  
  
  public override contextMenuRun(interaction: Command.ContextMenuCommandInteraction) {  
    // ...  
  }  
}
```

--------------------------------

### Initialize Sapphire Client (CommonJS)

Source: https://sapphirejs.dev/docs/General/Welcome

Basic setup for a Sapphire bot using CommonJS modules. Requires intents to be specified.

```javascript
const { SapphireClient } = require('@sapphire/framework');  

const client = new SapphireClient({ intents: ['GUILDS', 'GUILD_MESSAGES'] });  

client.login('your-token-goes-here');  

```

--------------------------------

### Install Snowflake with pnpm

Source: https://sapphirejs.dev/docs/Guide/utilities/snowflake

Use this command to install the Snowflake package using pnpm.

```bash
pnpm add @sapphire/snowflake  

```

--------------------------------

### Install Snowflake with yarn

Source: https://sapphirejs.dev/docs/Guide/utilities/snowflake

Use this command to install the Snowflake package using yarn.

```bash
yarn add @sapphire/snowflake  

```

--------------------------------

### Install Snowflake with npm

Source: https://sapphirejs.dev/docs/Guide/utilities/snowflake

Use this command to install the Snowflake package using npm.

```bash
npm install @sapphire/snowflake  

```

--------------------------------

### Timestamp pattern example

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-logger/interfaces/LoggerTimestampOptions

Example of the default timestamp pattern and its resulting output format.

```typescript
'YYYY-MM-DD HH:mm:ss'  
// 2020-12-23 22:01:10
```

--------------------------------

### Register the plugin

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-utilities-store

Import the registration file to initialize the plugin in your project.

```javascript
require('@sapphire/plugin-utilities-store/register');
```

```typescript
import '@sapphire/plugin-utilities-store/register';
```

--------------------------------

### init()

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-i18next/classes/InternationalizationHandler

Initializes the handler by loading in the namespaces and passing data to i18next.

```APIDOC
## init()

### Description
Initializes the handler by loading in the namespaces, passing the data to i18next, and filling in the InternationalizationHandler#languages.

### Returns
- **Promise<void>**
```

--------------------------------

### Argument Class - Usage Examples

Source: https://sapphirejs.dev/docs/Documentation/api-framework/classes/Argument

Examples demonstrating how to extend the Argument class in TypeScript and JavaScript.

```APIDOC
## Examples

```typescript
// TypeScript:  
import { Argument } from '@sapphire/framework';  
import { URL } from 'node:url';  
  
// Define a class extending `Argument`, then export it.  
// NOTE: You can use `export default` or `export =` too.  
export class CoreArgument extends Argument<URL> {  
  public constructor(context: Argument.LoaderContext) {  
    super(context, { name: 'hyperlink', aliases: ['url'] });  
  }  
  
  public run(argument: string, context: Argument.Context): Argument.Result<URL> {  
    try {  
      return this.ok(new URL(argument));  
    } catch {  
      return this.error({
        parameter: argument,
        context,
        identifier: 'ArgumentHyperlinkInvalidURL',
        message: 'The argument did not resolve to a valid URL.'
      });
    }
  }
}
  
// Augment the ArgType structure so `args.pick('url')`, `args.repeat('url')`  
// and others have a return type of `URL`.  
declare module '@sapphire/framework' {
  export interface ArgType {
    url: URL;
  }
}
```

```javascript
// JavaScript:  
const { Argument } = require('@sapphire/framework');  
  
// Define a class extending `Argument`, then export it.  
module.exports = class CoreArgument extends Argument {
  constructor(context) {
    super(context, { name: 'hyperlink', aliases: ['url'] });
  }

  run(argument, context) {
    try {
      return this.ok(new URL(argument));
    } catch {
      return this.error({
        parameter: argument,
        context,
        identifier: 'ArgumentHyperlinkInvalidURL',
        message: 'The argument did not resolve to a valid URL.'
      });
    }
  }
}
```
```

--------------------------------

### Choose Config File Format

Source: https://sapphirejs.dev/docs/Guide/CLI/getting-started

Select the format for your project's configuration file. You can choose between JSON and YAML.

```bash
sapphire new  
√ What's the name of your project? ... my-sapphire-bot  
√ Choose a language for your project » TypeScript (Recommended)  
√ Choose a template for your project » Default template (Recommended)  
? What format do you want your config file to be in? » - Use arrow-keys. Return to submit.  
    JSON  
>   YAML  
```

--------------------------------

### Test GET Route with cURL

Source: https://sapphirejs.dev/docs/Documentation/api-plugins/@sapphire/plugin-api/classes/Route

Verify the GET endpoint response using the curl command-line tool.

```bash
$ curl http://localhost:4000/hello  
{"message":"Hello, World!"}  
```

--------------------------------

### Initialize Sapphire Client (ESM)

Source: https://sapphirejs.dev/docs/General/Welcome

Basic setup for a Sapphire bot using ECMAScript Modules (ESM). Requires intents to be specified.

```javascript
import { SapphireClient } from '@sapphire/framework';  

const client = new SapphireClient({ intents: ['GUILDS', 'GUILD_MESSAGES'] });  

client.login('your-token-goes-here');  

```

--------------------------------

### PaginatedMessageActionUserMenu Example

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/discord.js-utilities/type-aliases/PaginatedMessageActionUserMenu

An example demonstrating how to create and use a PaginatedMessageActionUserMenu object for a User Select Menu component.

```APIDOC
## Example

```typescript
const UserMenu: PaginatedMessageActionUserMenu = {
  customId: 'CustomUserSelectMenu',
  type: ComponentType.UserSelect,
  run: ({ interaction }) => {
    if (interaction.isChannelSelectMenu()) {
      console.log(interaction.values[0])
    }
  }
}
```
```

--------------------------------

### Slice an iterable with a positive start index

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/iterator-utilities/functions/slice

Extracts elements starting from index 2 to the end of the iterable.

```typescript
const iterable = [1, 2, 3, 4, 5];  
console.log([...slice(iterable, 2)]);  
// Output: [3, 4, 5]  
```

--------------------------------

### Filesystem-based Routing Structure Example

Source: https://sapphirejs.dev/docs/Guide/plugins/API/upgrade-from-v6-to-V7

v7 introduces a file-system-based routing system where the folder and file structure automatically generates routes. Dynamic route parameters use the `[param]` syntax.

```plaintext
routes/  
  ├── guilds/  
  │   ├── [guild]/  
  │   │   └── members.get.ts  
  │   └── index.get.ts  
  └── users/  
      └── @me.get.ts  
```

--------------------------------

### Slice an iterable with a negative start index

Source: https://sapphirejs.dev/docs/Documentation/api-utilities/@sapphire/iterator-utilities/functions/slice

Extracts elements starting from the second to last element to the end.

```typescript
const iterable = [1, 2, 3, 4, 5];  
console.log([...slice(iterable, -2)]);  
// Output: [4, 5]  
```
Tokens:
Raw