# Interface: InkTextReplaceInfo (/pixi-vn-ink/vite/interfaces/InkTextReplaceInfo)



Defined in: [src/vite/info-types.ts:16](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L16)

Serializable representation of a registered TextReplaces handler,
as exposed by the pixi-vn-ink Vite dev-server API.

Instances of this type are returned by
`GET /__pixi-vn-ink/text-replaces`
and accepted by
`POST /__pixi-vn-ink/text-replaces`.

## See [#see]

[https://pixi-vn.com/ink#vite-plugin](https://pixi-vn.com/ink#vite-plugin)

## Properties [#properties]

### description? [#description]

\> `optional` **description?**: `string`

Defined in: [src/vite/info-types.ts:26](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L26)

Human-readable description of what the handler does.
Matches ReplaceHandlerOptions.description.

***

### name [#name]

\> **name**: `string`

Defined in: [src/vite/info-types.ts:21](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L21)

Unique name that identifies the handler.
Matches ReplaceHandlerOptions.name.

***

### type? [#type]

\> `optional` **type?**: `"before-translation"` | `"after-translation"`

Defined in: [src/vite/info-types.ts:36](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L36)

When the handler runs relative to the translation step.
Matches ReplaceHandlerOptions.type.

#### Default [#default]

```ts
"before-translation"
```

***

### validation [#validation]

\> **validation**: `InkValidationInfo`

Defined in: [src/vite/info-types.ts:30](https://github.com/DRincs-Productions/pixi-vn-ink/blob/5604a832025db23627dcf27e489490f9e7743d04/src/vite/info-types.ts#L30)

Serializable form of ReplaceHandlerOptions.validation.