# RegistryCodemod

Source: /tuil/docs/reference/packages/registry/api/registry-codemod
Locale: en

interface exported by @mwillbanks/tuil-registry.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-registry`.

```ts
export interface RegistryCodemod {
  readonly id: string;
  readonly description: string;
  readonly replacements: readonly {
    readonly from: string;
    readonly to: string;
  }[];
}
```

## Members [#members]

| Member         | Type                                                                   | Required | Description                                                                                                         | Related types |
| -------------- | ---------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- | ------------- |
| `id`           | `string`                                                               | Yes      | The `id` member uses the `string` contract.                                                                         | —             |
| `description`  | `string`                                                               | Yes      | The `description` member uses the `string` contract.                                                                | —             |
| `replacements` | `readonly { readonly from: string; readonly to: string; }[]` | Yes      | The `replacements` member uses the `readonly { readonly from: string; readonly to: string; }[]` contract. | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/registry/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-registry](/tuil/docs/reference/packages/registry)