# RegistrySource

Source: /tuil/docs/reference/packages/registry/api/registry-source
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 RegistrySource {
  readonly id: string;
  get(name: string, signal?: AbortSignal): Promise<RegistryItem | undefined>;
  list(signal?: AbortSignal): Promise<readonly RegistryIndexEntry[]>;
}
```

## Members [#members]

| Member | Type                                                                         | Required | Description                                                                                                      | Related types                                                                      |
| ------ | ---------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id`   | `string`                                                                     | Yes      | The `id` member uses the `string` contract.                                                                      | —                                                                                  |
| `get`  | `(name: string, signal?: AbortSignal) => Promise<RegistryItem \| undefined>` | Yes      | The `get` member uses the `(name: string, signal?: AbortSignal) => Promise<RegistryItem \| undefined>` contract. | [`RegistryItem`](/tuil/docs/reference/packages/registry/api/registry-item)              |
| `list` | `(signal?: AbortSignal) => Promise<readonly RegistryIndexEntry[]>`           | Yes      | The `list` member uses the `(signal?: AbortSignal) => Promise<readonly RegistryIndexEntry[]>` contract.          | [`RegistryIndexEntry`](/tuil/docs/reference/packages/registry/api/registry-index-entry) |

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

* [`RegistryIndexEntry`](/tuil/docs/reference/packages/registry/api/registry-index-entry)
* [`RegistryItem`](/tuil/docs/reference/packages/registry/api/registry-item)

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