Skip to content

x-to-zod / Context

Type Alias: Context

ts
type Context = Options & {
  adapter?: SchemaInputAdapter;
  build:   | buildV3
     | buildV4;
  builderRegistry?: BuilderRegistry;
  currentSchemaId?: string;
  dependencyGraph?: DependencyGraph;
  importManager?: ImportManager;
  matchPath?: (pattern) => boolean;
  path: (string | number)[];
  pathString?: string;
  postProcessors?: PostProcessorConfig[];
  refResolver?: DefaultRefResolver;
  seen: Map<object | boolean, {
     n: number;
     r: Builder | undefined;
  }>;
  transformers?: SchemaTransformer[];
};

Defined in: src/context.ts:30

Type Declaration

adapter?

ts
optional adapter?: SchemaInputAdapter;

Optional per-call adapter override; defaults to the global adapter

build

ts
build: 
  | buildV3
  | buildV4;

builderRegistry?

ts
optional builderRegistry?: BuilderRegistry;

Optional builder registry for caching builders across schemas

currentSchemaId?

ts
optional currentSchemaId?: string;

Current schema ID (used for resolving relative refs)

dependencyGraph?

ts
optional dependencyGraph?: DependencyGraph;

Optional dependency graph for cycle detection in SchemaProject

importManager?

ts
optional importManager?: ImportManager;

Optional import manager for collecting import statements

matchPath?

ts
optional matchPath?: (pattern) => boolean;

Parameters

pattern

string

Returns

boolean

path

ts
path: (string | number)[];

pathString?

ts
optional pathString?: string;

postProcessors?

ts
optional postProcessors?: PostProcessorConfig[];

refResolver?

ts
optional refResolver?: DefaultRefResolver;

Optional SchemaProject resolver for cross-schema $refs

seen

ts
seen: Map<object | boolean, {
  n: number;
  r: Builder | undefined;
}>;

transformers?

ts
optional transformers?: SchemaTransformer[];

Released under the ISC License.