RegistryIndexEntry
interface exported by @mwillbanks/tuil-registry.
interface
Public interface exported by @mwillbanks/tuil-registry.
export interface RegistryIndexEntry {
readonly name: string;
readonly type: RegistryItemType;
readonly title: string;
readonly description: string;
readonly tier?: 1 | 2 | 3 | 4;
readonly version?: string;
readonly packageName?: string;
readonly ownership?: RegistryItem["ownership"];
readonly integrity?: string;
readonly compatibility?: RegistryItem["compatibility"];
readonly deprecated?: RegistryItem["deprecated"];
readonly codemods?: RegistryItem["codemods"];
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?: RegistryItem["provenance"];
readonly files?: readonly Pick<RegistryFile, "path" | "target" | "source">[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
name | string | Yes | The name member uses the string contract. | — |
type | RegistryItemType | Yes | The type member uses the RegistryItemType contract. | RegistryItemType |
title | string | Yes | The title member uses the string contract. | — |
description | string | Yes | The description member uses the string contract. | — |
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 |
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 Pick<RegistryFile, "source" | "path" | "target">[] | undefined | No | The files member uses the readonly Pick<RegistryFile, "source" | "path" | "target">[] | undefined contract. | RegistryFile |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference