Interface ITsModulesCompilerOptions<M, C>

Type parameters

M
C

Hierarchy

Omit<ITsTypesCompilerOptions<M>, "resolveExternalRef">
Omit<IValidatorCompilerOptions<M, C>, "dialect">
IJtdcDialectOptions<M>
- ITsModulesCompilerOptions

Index

Properties

Methods

Properties

Optional typeGuardsRendered

typeGuardsRendered: boolean

If set to true then type guards are rendered along with validators.

see: TypeScript Narrowing

Optional validatorsRendered

validatorsRendered: boolean

If true then validator functions are rendered along with types.

Methods

Optional dialectFactory

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

- Defined in packages/compiler/src/main/ts-modules-compiler.ts:22
The callback that produces the validator compilation dialect.

Parameters
- Optional options: IJtdcDialectOptions<M>
Returns IJtdcDialect<M, C>

Optional getDocComment

getDocComment(node: JtdNode<M>): undefined | null | string

Inherited from Omit.getDocComment
- Defined in packages/compiler/src/main/ts-types-compiler.ts:76
Returns the doc comment string that is associated with the node.

default

node.metadata?.comment

Parameters
- node: JtdNode<M>
Returns undefined | null | string

Optional renameDiscriminatorKey

renameDiscriminatorKey(node: IJtdUnionNode<M>): string

Inherited from IJtdcDialectOptions.renameDiscriminatorKey
- Defined in packages/compiler/src/main/ts-types-compiler.ts:59
Returns the name of the union discriminator property.

Parameters
- node: IJtdUnionNode<M>
Returns string

Optional renameEnumKey

renameEnumKey(value: string, node: IJtdEnumNode<M>): string

Inherited from Omit.renameEnumKey
- Defined in packages/compiler/src/main/ts-types-compiler.ts:39
Returns the name of the enum key.

Parameters
- value: string
- node: IJtdEnumNode<M>
Returns string

Optional renameMappingInterface

renameMappingInterface(mappingKey: string, mappingNode: IJtdObjectNode<M>, unionRef: string, unionNode: IJtdUnionNode<M>): string

Inherited from Omit.renameMappingInterface
- Defined in packages/compiler/src/main/ts-types-compiler.ts:69
Returns the name of the interface that is the part of the discriminated union.

Parameters
- mappingKey: string
- mappingNode: IJtdObjectNode<M>
- unionRef: string
- unionNode: IJtdUnionNode<M>
Returns string

Optional renamePropertyKey

renamePropertyKey(propKey: string, propNode: JtdNode<M>, objectNode: IJtdObjectNode<M>): string

Inherited from IJtdcDialectOptions.renamePropertyKey
- Defined in packages/compiler/src/main/ts-types-compiler.ts:34
Returns the new name of an object property.

Parameters
- propKey: string
- propNode: JtdNode<M>
- objectNode: IJtdObjectNode<M>
Returns string

Optional renameType

renameType(ref: string, node: JtdNode<M>): string

Inherited from IJtdcDialectOptions.renameType
- Defined in packages/compiler/src/main/ts-types-compiler.ts:20
Returns a TypeScript type name described by node.

Parameters
- ref: string
  
  The ref of the renamed type.
- node: JtdNode<M>
  
  The node that describes the renamed type.
Returns string

Optional renameTypeGuard

renameTypeGuard(ref: string, node: JtdNode<M>): string

Inherited from IJtdcDialectOptions.renameTypeGuard
- Defined in packages/types/src/main/dialect-types.ts:47
Returns the name of the type guard function.

Parameters
- ref: string
- node: JtdNode<M>
Returns string

Optional renameUnionEnum

renameUnionEnum(ref: string, node: IJtdUnionNode<M>): string

Inherited from Omit.renameUnionEnum
- Defined in packages/compiler/src/main/ts-types-compiler.ts:49
Returns the name of the enum that holds mapping keys for the discriminated union.

Parameters
- ref: string
- node: IJtdUnionNode<M>
Returns string

Optional renameUnionEnumKey

renameUnionEnumKey(mappingKey: string, mappingNode: IJtdObjectNode<M>, unionRef: string, unionNode: IJtdUnionNode<M>): string

Inherited from Omit.renameUnionEnumKey
- Defined in packages/compiler/src/main/ts-types-compiler.ts:54
Returns the contents of the value from the enum that holds discriminator values.

Parameters
- mappingKey: string
- mappingNode: IJtdObjectNode<M>
- unionRef: string
- unionNode: IJtdUnionNode<M>
Returns string

Optional renameValidator

renameValidator(ref: string, node: JtdNode<M>): string

Inherited from IJtdcDialectOptions.renameValidator
- Defined in packages/types/src/main/dialect-types.ts:22
Returns the name of the emitted validator function.

Parameters
- ref: string
- node: JtdNode<M>
Returns string

Optional rewriteEnumValue

rewriteEnumValue(value: string, node: IJtdEnumNode<M>): undefined | string | number

Inherited from IJtdcDialectOptions.rewriteEnumValue
- Defined in packages/compiler/src/main/ts-types-compiler.ts:44
Returns the contents of the enum value.

Parameters
- value: string
- node: IJtdEnumNode<M>
Returns undefined | string | number

Optional rewriteMappingKey

rewriteMappingKey(mappingKey: string, mappingNode: IJtdObjectNode<M>, unionRef: undefined | string, unionNode: IJtdUnionNode<M>): undefined | string | number

Inherited from IJtdcDialectOptions.rewriteMappingKey
- Defined in packages/compiler/src/main/ts-types-compiler.ts:64
Returns the value that would be used as a value of the discriminator property.

Parameters
- mappingKey: string
- mappingNode: IJtdObjectNode<M>
- unionRef: undefined | string
- unionNode: IJtdUnionNode<M>
Returns undefined | string | number

Optional rewritePrimitiveType

rewritePrimitiveType(node: IJtdTypeNode<M>): string

Inherited from Omit.rewritePrimitiveType
- Defined in packages/compiler/src/main/ts-types-compiler.ts:29
Returns a TypeScript type name of a JTD primitive type. By default, a jtdTsPrimitiveTypeMap is used to resolve the name.

example

(node) => node.type === 'int64' ? 'bigint' : 'string'

Parameters
- node: IJtdTypeNode<M>
Returns string

Generated using TypeDoc