RegistryInstallOptions
interface exported by @mwillbanks/tuil-registry.
interface
Public interface exported by @mwillbanks/tuil-registry.
export interface RegistryInstallOptions extends RegistryTransformOptions {
readonly force?: boolean;
readonly frozenLockfile?: boolean;
readonly environment?: {
readonly renderer: string;
readonly capabilities: ReadonlySet<string>;
readonly tuilVersion: string;
};
}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 | { readonly renderer: string; readonly capabilities: ReadonlySet<string>; readonly tuilVersion: string; } | undefined | No | The environment member uses the { readonly renderer: string; readonly capabilities: ReadonlySet<string>; readonly tuilVersion: string; } | 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
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