UNPKG

@sinclair/typebox

Version:

Json Schema Type Builder with Static Type Resolution for TypeScript

github.com/sinclairzx81/typebox

sinclairzx81/typebox

16 lines (15 loc) • 1.57 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import * as Types from '../type/index.mjs'; import { Static } from './parsebox/index.mjs'; import { Main } from './static.mjs'; /** `[Syntax]` Infers a TypeBox type from TypeScript syntax. */ export type StaticParseAsSchema<Context extends Record<PropertyKey, Types.TSchema>, Code extends string> = Static.Parse<Main, Code, Context>[0]; /** `[Syntax]` Infers a TypeScript type from TypeScript syntax. */ export type StaticParseAsType<Context extends Record<PropertyKey, Types.TSchema>, Code extends string> = StaticParseAsSchema<Context, Code> extends infer Type extends Types.TSchema ? Types.StaticDecode<Type> : undefined; /** `[Syntax]` Parses a TypeBox type from TypeScript syntax. */ export declare function Parse<Context extends Record<PropertyKey, Types.TSchema>, Code extends string>(context: Context, code: Code, options?: Types.SchemaOptions): StaticParseAsSchema<Context, Code>; /** `[Syntax]` Parses a TypeBox type from TypeScript syntax. */ export declare function Parse<Code extends string>(code: Code, options?: Types.SchemaOptions): StaticParseAsSchema<{}, Code>; /** `[Syntax]` Parses a TypeBox TSchema from TypeScript syntax. This function does not infer the type. */ export declare function ParseOnly<Context extends Record<PropertyKey, Types.TSchema>, Code extends string>(context: Context, code: Code, options?: Types.SchemaOptions): Types.TSchema | undefined; /** `[Syntax]` Parses a TypeBox TSchema from TypeScript syntax */ export declare function ParseOnly<Code extends string>(code: Code, options?: Types.SchemaOptions): Types.TSchema | undefined;