Interface ISchema

src/types.ts:15–30

export type { AnyObject, AnySchema };

export interface ISchema<T, C = any, F extends Flags = any, D = any> {
  __flags: F;
  __context: C;
  __outputType: T;
  __default: D;

  cast(value: any, options?: CastOptions<C>): T;
  cast(value: any, options: CastOptionalityOptions<C>): T | null | undefined;

  validate(value: any, options?: ValidateOptions<C>): Promise<T>;

  asNestedTest(config: NestedTestConfig): Test;

  describe(options?: ResolveOptions<C>): SchemaFieldDescription;
  resolve(options: ResolveOptions<C>): ISchema<T, C, F>;
}

export type InferType<T extends ISchema<any, any>> = T['__outputType'];