# RegistryItem

Source: /tuil/docs/reference/packages/registry/api/registry-item
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 RegistryItem {
  readonly name: string;
  readonly registryName?: string;
  readonly sourceId?: string;
  readonly type: RegistryItemType;
  readonly tier?: 1 | 2 | 3 | 4;
  readonly version?: string;
  readonly packageName?: string;
  readonly ownership?: "source" | "package" | "plugin";
  readonly integrity?: string;
  readonly compatibility?: {
    readonly tuil?: string;
    readonly renderers?: readonly string[];
    readonly capabilities?: readonly string[];
  };
  readonly deprecated?: {
    readonly message: string;
    readonly replacement?: string;
    readonly since?: string;
  };
  readonly codemods?: readonly RegistryCodemod[];
  readonly title: string;
  readonly description: string;
  readonly renderer?: string;
  readonly capabilities?: readonly string[];
  readonly semantics?: readonly string[];
  readonly dependencies?: readonly string[];
  readonly registryDependencies?: readonly string[];
  readonly slots?: readonly string[];
  readonly provenance?: {
    readonly source: string;
    readonly license?: string;
    readonly mode?: "use" | "wrap" | "adapt" | "replace" | "reference";
  };
  readonly files: readonly RegistryFile[];
}
```

## Members [#members]

| Member                 | Type                                                                                                                                                     | Required | Description                                                                                                                                                                                         | Related types                                                                  |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `name`                 | `string`                                                                                                                                                 | Yes      | The `name` member uses the `string` contract.                                                                                                                                                       | —                                                                              |
| `registryName`         | `string \| undefined`                                                                                                                                    | No       | The `registryName` member uses the `string \| undefined` contract.                                                                                                                                  | —                                                                              |
| `sourceId`             | `string \| undefined`                                                                                                                                    | No       | The `sourceId` member uses the `string \| undefined` contract.                                                                                                                                      | —                                                                              |
| `type`                 | `RegistryItemType`                                                                                                                                       | Yes      | The `type` member uses the `RegistryItemType` contract.                                                                                                                                             | [`RegistryItemType`](/tuil/docs/reference/packages/registry/api/registry-item-type) |
| `tier`                 | `1 \| 2 \| 3 \| 4 \| undefined`                                                                                                                          | No       | The `tier` member uses the `1 \| 2 \| 3 \| 4 \| undefined` contract.                                                                                                                                | —                                                                              |
| `version`              | `string \| undefined`                                                                                                                                    | No       | The `version` member uses the `string \| undefined` contract.                                                                                                                                       | —                                                                              |
| `packageName`          | `string \| undefined`                                                                                                                                    | No       | The `packageName` member uses the `string \| undefined` contract.                                                                                                                                   | —                                                                              |
| `ownership`            | `"plugin" \| "source" \| "package" \| undefined`                                                                                                         | No       | The `ownership` member uses the `"plugin" \| "source" \| "package" \| undefined` contract.                                                                                                          | —                                                                              |
| `integrity`            | `string \| undefined`                                                                                                                                    | No       | The `integrity` member uses the `string \| undefined` contract.                                                                                                                                     | —                                                                              |
| `compatibility`        | `{ readonly tuil?: string; readonly renderers?: readonly string[]; readonly capabilities?: readonly string[]; } \| undefined`                  | No       | The `compatibility` member uses the `{ readonly tuil?: string; readonly renderers?: readonly string[]; readonly capabilities?: readonly string[]; } \| undefined` contract.               | —                                                                              |
| `deprecated`           | `{ readonly message: string; readonly replacement?: string; readonly since?: string; } \| undefined`                                           | No       | The `deprecated` member uses the `{ readonly message: string; readonly replacement?: string; readonly since?: string; } \| undefined` contract.                                           | —                                                                              |
| `codemods`             | `readonly RegistryCodemod[] \| undefined`                                                                                                                | No       | The `codemods` member uses the `readonly RegistryCodemod[] \| undefined` contract.                                                                                                                  | [`RegistryCodemod`](/tuil/docs/reference/packages/registry/api/registry-codemod)    |
| `title`                | `string`                                                                                                                                                 | Yes      | The `title` member uses the `string` contract.                                                                                                                                                      | —                                                                              |
| `description`          | `string`                                                                                                                                                 | Yes      | The `description` member uses the `string` contract.                                                                                                                                                | —                                                                              |
| `renderer`             | `string \| undefined`                                                                                                                                    | No       | The `renderer` member uses the `string \| undefined` contract.                                                                                                                                      | —                                                                              |
| `capabilities`         | `readonly string[] \| undefined`                                                                                                                         | No       | The `capabilities` member uses the `readonly string[] \| undefined` contract.                                                                                                                       | —                                                                              |
| `semantics`            | `readonly string[] \| undefined`                                                                                                                         | No       | The `semantics` member uses the `readonly string[] \| undefined` contract.                                                                                                                          | —                                                                              |
| `dependencies`         | `readonly string[] \| undefined`                                                                                                                         | No       | The `dependencies` member uses the `readonly string[] \| undefined` contract.                                                                                                                       | —                                                                              |
| `registryDependencies` | `readonly string[] \| undefined`                                                                                                                         | No       | The `registryDependencies` member uses the `readonly string[] \| undefined` contract.                                                                                                               | —                                                                              |
| `slots`                | `readonly string[] \| undefined`                                                                                                                         | No       | The `slots` member uses the `readonly string[] \| undefined` contract.                                                                                                                              | —                                                                              |
| `provenance`           | `{ readonly source: string; readonly license?: string; readonly mode?: "use" \| "wrap" \| "adapt" \| "replace" \| "reference"; } \| undefined` | No       | The `provenance` member uses the `{ readonly source: string; readonly license?: string; readonly mode?: "use" \| "wrap" \| "adapt" \| "replace" \| "reference"; } \| undefined` contract. | —                                                                              |
| `files`                | `readonly RegistryFile[]`                                                                                                                                | Yes      | The `files` member uses the `readonly RegistryFile[]` contract.                                                                                                                                     | [`RegistryFile`](/tuil/docs/reference/packages/registry/api/registry-file)          |

## 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]

* [`RegistryCodemod`](/tuil/docs/reference/packages/registry/api/registry-codemod)
* [`RegistryFile`](/tuil/docs/reference/packages/registry/api/registry-file)
* [`RegistryItemType`](/tuil/docs/reference/packages/registry/api/registry-item-type)

## 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)