`BuildRegistryOptions`

인터페이스, 도구 분류

Options for buildRegistry.

import type { BuildRegistryOptions } from 'typeshade'

시그니처, 설명, 예제는 커밋 c66579bf의 컴파일러 소스에서 그대로 가져온 영어 원문입니다.

구문

interface BuildRegistryOptions {
  readonly order?: readonly string[];
  readonly typeName?: string;
  readonly recordName?: string;
  readonly valueType?: string;
  readonly imports?: readonly string[];
  readonly regenerateWith?: string;
  readonly stamp?: string;
}

인스턴스 속성

order선택 사항읽기 전용 readonly string[]: The curated id order. When given, it must name every discovered id and no others: a new module nobody registered, or a registered id whose module was deleted, both make buildRegistry throw. Omit to use discovery order.
typeName선택 사항읽기 전용 string: Name of the generated union type. Default RegistryKey.
recordName선택 사항읽기 전용 string: Name of the generated id → module record. Default REGISTRY.
valueType선택 사항읽기 전용 string: Type annotation for a registry value, e.g. ShaderExample. Default unknown.
imports선택 사항읽기 전용 readonly string[]: Extra import line(s) placed above the generated ones, where valueType comes from.
regenerateWith선택 사항읽기 전용 string: The command that regenerates this file. It is named in the generated file’s banner and in the error message when order and the discovered set disagree, so a reader who hits that failure knows what to run.
stamp선택 사항읽기 전용 string: The emit identity the registry’s shader artifacts were produced with; pass the string returned by emitIdentity. It is recorded in the generated file’s banner, so a committed registry says which emit configuration wrote it. When two builds produce different output from the same modules, the first line of the diff then names the difference.

함께 보기

소스

src/core/registry.ts, 38행, 커밋 c66579bf 기준

이 페이지 편집 문제 보고