Interface: PixivnCharacterIds

Defined in: src/characters/types/CharacterIdType.ts:26

An empty interface that can be augmented via declare module '@drincs/pixi-vn/characters' to constrain the set of valid character IDs to a known union of string literals.

When this interface has no keys (the default), CharacterIdType resolves to string, preserving full backwards compatibility. Once you augment it, CharacterIdType becomes the union of the declared keys and the compiler will reject any unknown character ID.

The augmentation is typically written into an auto-generated declaration file by the Vite plugin (see the typeFilePath option of vitePluginPixivn), but it can also be written by hand.

Example

// pixi-vn.gen.d.ts  (auto-generated — do not edit manually)
declare module "@drincs/pixi-vn/characters" {
    interface PixivnCharacterIds {
        liam: never;
        emma: never;
    }
}
export {};