# Interface: PixivnCharacterIds (/jsdoc/pixi-vn/index/interfaces/PixivnCharacterIds)



Defined in: [src/characters/types/CharacterIdType.ts:26](https://github.com/DRincs-Productions/pixi-vn/blob/efc9536feda21bc17c50370f5e35fd8d8d88843a/src/characters/types/CharacterIdType.ts#L26)

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](/jsdoc/pixi-vn/index/type-aliases/CharacterIdType) resolves to `string`,
preserving full backwards compatibility. Once you augment it, [CharacterIdType](/jsdoc/pixi-vn/index/type-aliases/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 [#example]

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