Skip to main content

API Reference

Yukino's API is organized into several main components:

Core Components​

YukinoClient​

The main client class that handles connection to Lavalink and player management.

import { YukinoClient } from 'yukinojs';

Node​

Manages the WebSocket connection to Lavalink and handles events.

import { Node } from 'yukinojs';

Player​

Handles playback control and audio manipulation for a guild.

import { Player } from 'yukinojs';

Queue​

Manages track queues for players.

import { Queue } from 'yukinojs';

Rest​

Handles HTTP communication with the Lavalink server.

import { Rest } from 'yukinojs';

Connectors​

Connector​

Base class for platform-specific connectors.

import { Connector } from 'yukinojs';

DiscordJSConnector​

Discord.js-specific implementation.

import { DiscordJSConnector } from 'yukinojs';

Filters & Effects​

FilterUtil​

Utility class for audio filters and effects.

import { FilterUtil } from 'yukinojs';

Types & Interfaces​

Events​

Event constants used throughout the library.

import { Events } from 'yukinojs';

LoadTypes​

Track loading result types.

import { LoadTypes } from 'yukinojs';

State​

Connection state constants.

import { State } from 'yukinojs';

PlayerStates​

Player state constants.

import { PlayerStates } from 'yukinojs';

Configuration Interfaces​

Filter Interfaces​

Utility Types​

Other Utilities​

  • Logger (add documentation if not present)
  • Utils (add documentation if not present)

Note: All main classes, types, and utilities are re-exported from the main entry point. Import everything from 'yukinojs'.