# RegistryInstallOptions

Source: /tuil/docs/reference/packages/registry/api/registry-install-options
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 RegistryInstallOptions extends RegistryTransformOptions {
  readonly force?: boolean;
  readonly frozenLockfile?: boolean;
  readonly environment?: {
    readonly renderer: string;
    readonly capabilities: ReadonlySet<string>;
    readonly tuilVersion: string;
  };
}
```

## Members [#members]

| Member               | Type                                                                                                                              | Required | Description                                                                                                                                                                   | Related types |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `force`              | `boolean \| undefined`                                                                                                            | No       | The `force` member uses the `boolean \| undefined` contract.                                                                                                                  | —             |
| `frozenLockfile`     | `boolean \| undefined`                                                                                                            | No       | The `frozenLockfile` member uses the `boolean \| undefined` contract.                                                                                                         | —             |
| `environment`        | `&#123; readonly renderer: string; readonly capabilities: ReadonlySet<string>; readonly tuilVersion: string; &#125; \| undefined` | No       | The `environment` member uses the `&#123; readonly renderer: string; readonly capabilities: ReadonlySet<string>; readonly tuilVersion: string; &#125; \| undefined` contract. | —             |
| `importAliases`      | `Readonly<Record<string, string>> \| undefined`                                                                                   | No       | The `importAliases` member uses the `Readonly<Record<string, string>> \| undefined` contract.                                                                                 | —             |
| `componentDirectory` | `string \| undefined`                                                                                                             | No       | The `componentDirectory` member uses the `string \| undefined` contract.                                                                                                      | —             |
| `themeTokens`        | `Readonly<Record<string, string>> \| undefined`                                                                                   | No       | The `themeTokens` member uses the `Readonly<Record<string, string>> \| undefined` contract.                                                                                   | —             |
| `format`             | `((content: string, target: string) => string \| Promise<string>) \| undefined`                                                   | No       | The `format` member uses the `((content: string, target: string) => string \| Promise<string>) \| undefined` 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]

* [`RegistryTransformOptions`](/tuil/docs/reference/packages/registry/api/registry-transform-options)

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