Structure Types

This entry summarizes the inferred *Structure aliases exposed by Hoshimi. Use these types to keep extensions strongly typed when overriding built-in structures.

Type reference: Core API (TypeDoc)

Quick links:

• Structures
• InferCustomStructure
• PlayerStructure
• NodeStructure
• QueueStructure
• TrackStructure
• UnresolvedTrackStructure
• LyricsManagerStructure
• NodeManagerStructure
• FilterManagerStructure
• PlayerVoiceStateStructure

What These Types Are

*Structure aliases represent the final instance type returned by each factory in Structures.

Practical Pattern

import type { PlayerStructure, TrackStructure } from 'hoshimi';

function attachPlayerFeatures(player: PlayerStructure): void {
  // Works with default Player or any custom Player replacement.
  console.log(player.guildId);
}

function inspectTrack(track: TrackStructure): string {
  return track.info.title;
}

Why It Matters

• Keeps extensions strongly typed after overrides.
• Avoids coupling app code to a concrete built-in class.
• Makes module augmentation with CustomizableStructures predictable.