jtdc

Index

Enumerations

Interfaces

Type aliases

JtdNode

Variables

Functions

Type aliases

JtdNode

Type parameters

Variables

Const jtdDialectOptions

jtdDialectOptions: Required<IJtdcDialectOptions<any>> = ...

Global default options used by createJtdDialect.

Const jtdTsPrimitiveTypeMap

jtdTsPrimitiveTypeMap: Record<string, string> = ...

Mapping from the JTD standard data types to TypeScript primitive types.

Const tsTypesCompilerOptions

tsTypesCompilerOptions: Required<ITsTypesCompilerOptions<any>> = ...

Global default options used by compileTsTypes.

Const validatorCompilerOptions

validatorCompilerOptions: Required<IValidatorCompilerOptions<any, any>> = ...

Functions

compileTsModules

compileTsModules<M, C>(jtdModules: Record<string, Record<string, IJtd<M>>>, options?: ITsModulesCompilerOptions<M, C>): Record<string, string>

- Defined in packages/compiler/src/main/ts-modules-compiler.ts:31
Compiles map of JTD definitions to a map of corresponding sources.

Type parameters
- M
- C
Parameters
- jtdModules: Record<string, Record<string, IJtd<M>>>
  
  The map from module URI to JTD definitions map.
- Optional options: ITsModulesCompilerOptions<M, C>
  
  Compiler options.
Returns Record<string, string>

compileTsTypes

compileTsTypes<M>(definitions: Record<string, JtdNode<M>>, options?: ITsTypesCompilerOptions<M>): string

- Defined in packages/compiler/src/main/ts-types-compiler.ts:87
Compiles provided JTD definitions as a TypeScript source.

Type parameters
- M
Parameters
- definitions: Record<string, JtdNode<M>>
  
  Map from ref to JTD node.
- Optional options: ITsTypesCompilerOptions<M>
  
  The compilation options.
Returns string

The TypeScript source code with type, interface and enum definitions.

compileValidators

compileValidators<M, C>(definitions: Record<string, JtdNode<M>>, options?: IValidatorCompilerOptions<M, C>): string

- Defined in packages/compiler/src/main/validators-compiler.ts:24
Compiles validators and type guards from the definitions.

Type parameters
- M
- C
Parameters
- definitions: Record<string, JtdNode<M>>
- Optional options: IValidatorCompilerOptions<M, C>
Returns string

createJtdDialect

createJtdDialect<M>(options?: IJtdcDialectOptions<M>): IJtdcDialect<M, IJtdDialectContext>

- Defined in packages/jtd-dialect/src/main/jtd-dialect.ts:33
Creates a validator compilation dialect that renders validators which follow the JTD specification.

Type parameters
- M
Parameters
- Optional options: IJtdcDialectOptions<M>
Returns IJtdcDialect<M, IJtdDialectContext>

dialectFactory

dialectFactory<M>(options?: IJtdcDialectOptions<M>): IJtdcDialect<M, IJtdDialectContext>

- Defined in packages/jtd-dialect/src/main/jtd-dialect.ts:33
Creates a validator compilation dialect that renders validators which follow the JTD specification.

Type parameters
- M
Parameters
- Optional options: IJtdcDialectOptions<M>
Returns IJtdcDialect<M, IJtdDialectContext>

parseJtd

parseJtd<M>(jtd: IJtd<M>): JtdNode<M>

- Defined in packages/compiler/src/main/jtd-ast.ts:54
Converts JTD to a corresponding node.

see

https://tools.ietf.org/html/rfc8927 RFC8927

see

https://jsontypedef.com/docs/jtd-in-5-minutes JTD in 5 minutes

Type parameters
- M
Parameters
- jtd: IJtd<M>
  
  The JTD to parse.
Returns JtdNode<M>

A parsed node.

parseJtdDefinitions

parseJtdDefinitions<M>(jtdDefinitions: Record<string, IJtd<M>>): Record<string, JtdNode<M>>

- Defined in packages/compiler/src/main/jtd-ast.ts:35
Converts JTD dependencies to a map of nodes where key is ref and value is a parsed node.

Type parameters
- M
Parameters
- jtdDefinitions: Record<string, IJtd<M>>
  
  The dictionary of ref-JTD pairs.
Returns Record<string, JtdNode<M>>

The map from ref to a parsed node.

parseJtdRoot

parseJtdRoot<M>(ref: string, jtdRoot: IJtdRoot<M>): Record<string, JtdNode<M>>

- Defined in packages/compiler/src/main/jtd-ast.ts:22
Converts JTD and its dependencies to a map of nodes where key is ref and value is a parsed node.

Type parameters
- M
Parameters
- ref: string
  
  The ref of the root JTD.
- jtdRoot: IJtdRoot<M>
  
  The JTD to parse.
Returns Record<string, JtdNode<M>>

The map from ref to a parsed node.

visitJtdNode

visitJtdNode<M>(node: JtdNode<M>, visitor: IJtdNodeVisitor<M>): void

- Defined in packages/compiler/src/main/jtd-visitor.ts:39
Invokes callbacks from visitor for each node tree under node.

Type parameters
- M
Parameters
- node: JtdNode<M>
  
  The root of the JTD node tree.
- visitor: IJtdNodeVisitor<M>
  
  Callbacks that must be invoked for nodes under node.
Returns void

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

JtdNode

Type parameters

M

Variables

Const jtdDialectOptions

Const jtdTsPrimitiveTypeMap

Const tsTypesCompilerOptions

Const validatorCompilerOptions

Functions

compileTsModules

Type parameters

M

C

Parameters

jtdModules: Record<string, Record<string, IJtd<M>>>

Optional options: ITsModulesCompilerOptions<M, C>

Returns Record<string, string>

compileTsTypes

Type parameters

M

Parameters

definitions: Record<string, JtdNode<M>>

Optional options: ITsTypesCompilerOptions<M>

Returns string

compileValidators

Type parameters

M

C

Parameters

definitions: Record<string, JtdNode<M>>

Optional options: IValidatorCompilerOptions<M, C>

Returns string

createJtdDialect

Type parameters

M

Parameters

Optional options: IJtdcDialectOptions<M>

Returns IJtdcDialect<M, IJtdDialectContext>

dialectFactory

Type parameters

M

Parameters

Optional options: IJtdcDialectOptions<M>

Returns IJtdcDialect<M, IJtdDialectContext>

parseJtd

Type parameters

M

Parameters

jtd: IJtd<M>

Returns JtdNode<M>

parseJtdDefinitions

Type parameters

M

Parameters

jtdDefinitions: Record<string, IJtd<M>>

Returns Record<string, JtdNode<M>>

parseJtdRoot

Type parameters

M

Parameters

ref: string

jtdRoot: IJtdRoot<M>

Returns Record<string, JtdNode<M>>

visitJtdNode

Type parameters

M

Parameters

node: JtdNode<M>

visitor: IJtdNodeVisitor<M>

Returns void