Class TemplateState

Hierarchy

TemplateState

Constructors

constructor

new TemplateState(originalSetter: string | ContainerAccessor, originalAccessor: string | ContainerAccessor, compilerContext: CompilerContext, registry: TemplateRegistry, namingStrategy?: NamingStrategy, jitStack?: JitStack, path?: (string | RuntimeCode)[]): TemplateState
Parameters
- originalSetter: string | ContainerAccessor
- originalAccessor: string | ContainerAccessor
- compilerContext: CompilerContext
- registry: TemplateRegistry
- namingStrategy: NamingStrategy = ...
- jitStack: JitStack = ...
- path: (string | RuntimeCode)[] = []
Returns TemplateState
- Defined in packages/type/src/serializer.ts:350

Properties

accessor

accessor: string | ContainerAccessor = ''

`Optional` allSpecificalities

allSpecificalities?: TypeGuardRegistry

When this is set all specificalities are used (used in union type guards to detect which member to pick).

compilerContext

compilerContext: CompilerContext

ended

ended: boolean = false

`Protected` handledAnnotations

handledAnnotations: AnnotationDefinition<true>[] = []

jitStack

jitStack: JitStack = ...

namingStrategy

namingStrategy: NamingStrategy = ...

originalAccessor

originalAccessor: string | ContainerAccessor

originalSetter

originalSetter: string | ContainerAccessor

path

path: (string | RuntimeCode)[] = []

`Optional` propertyName

propertyName?: string | RuntimeCode

registry

registry: TemplateRegistry

setter

setter: string | ContainerAccessor = ''

setterDisabled

setterDisabled: boolean = false

target

target: "serialize" | "deserialize" = 'serialize'

template

template: string = ''

Before and after template content is rendered before/after all other templates. When a template is put into its own function, before/after templates are run outside of this function.

`Optional` validation

validation?: "strict" | "loose"

Strict means only use type guards of specificality of 1 (used for is()/validation()). For deserialization loose is used.

Accessors

isDeserialization

get isDeserialization(): boolean
Returns boolean
- Defined in packages/type/src/serializer.ts:435

isSerialization

get isSerialization(): boolean
Returns boolean
- Defined in packages/type/src/serializer.ts:431

Methods

addCode

addCode(code: string): void
Parameters
- code: string
Returns void
- Defined in packages/type/src/serializer.ts:489

addCodeForSetter

addCodeForSetter(code: string): void
Adds template code for setting the this.setter variable manually, so use ${state.setter} = value. this.accessor will point now to this.setter.
Parameters
- code: string
Returns void
- Defined in packages/type/src/serializer.ts:497

addSetter

addSetter(code: string | {
toString: any;
}): void
Adds template code for setting the this.setter variable. The expression evaluated in code is assigned to this.setter. this.accessor will point now to this.setter.
Parameters
- code: string | {
  toString: any;
  }
Returns void
- Defined in packages/type/src/serializer.ts:459

addSetterAndReportErrorIfInvalid

addSetterAndReportErrorIfInvalid(errorCode: string, message: string, code: string): void
Parameters
- errorCode: string
- message: string
- code: string
Returns void
- Defined in packages/type/src/serializer.ts:464

annotationHandled

annotationHandled(annotation: AnnotationDefinition<any>): void
Can be used to track which annotation was already handled. Necessary to use with isAnnotationHandled to avoid infinite recursive loops when a serializer template issues sub calls depending on annotation data.
Parameters
- annotation: AnnotationDefinition<any>
Returns void
- Defined in packages/type/src/serializer.ts:423

assignValidationError

assignValidationError(code: string, message: string): string
Parameters
- code: string
- message: string
Returns string
- Defined in packages/type/src/serializer.ts:444

disableSetter

disableSetter(): TemplateState
Returns TemplateState
- Defined in packages/type/src/serializer.ts:409

enableSetter

enableSetter(): TemplateState
Returns TemplateState
- Defined in packages/type/src/serializer.ts:414

extendPath

extendPath(path: string | number | symbol | RuntimeCode): TemplateState
Parameters
- path: string | number | symbol | RuntimeCode
Returns TemplateState
- Defined in packages/type/src/serializer.ts:439

forPropertyName

forPropertyName(name?: string | number | symbol | RuntimeCode): TemplateState
Parameters
- Optional name: string | number | symbol | RuntimeCode
Returns TemplateState
- Defined in packages/type/src/serializer.ts:403

forRegistry

forRegistry(registry: TemplateRegistry): TemplateState
Parameters
- registry: TemplateRegistry
Returns TemplateState
- Defined in packages/type/src/serializer.ts:398

fork

fork(setter?: string | ContainerAccessor, accessor?: string | ContainerAccessor, path?: (string | RuntimeCode)[]): TemplateState
Forks as state, with an empty propertyName.
Parameters
- Optional setter: string | ContainerAccessor
- Optional accessor: string | ContainerAccessor
- Optional path: (string | RuntimeCode)[]
Returns TemplateState
- Defined in packages/type/src/serializer.ts:384

fullFork

fullFork(): TemplateState
Returns TemplateState
- Defined in packages/type/src/serializer.ts:394

hasSetterCode

hasSetterCode(): boolean
Returns boolean
- Defined in packages/type/src/serializer.ts:502

includeAllSpecificalities

includeAllSpecificalities(guardRegistry: TypeGuardRegistry): TemplateState
Parameters
- guardRegistry: TypeGuardRegistry
Returns TemplateState
- Defined in packages/type/src/serializer.ts:372

isAnnotationHandled

isAnnotationHandled(annotation: AnnotationDefinition<any>): boolean
Parameters
- annotation: AnnotationDefinition<any>
Returns boolean
- Defined in packages/type/src/serializer.ts:427

isValidation

isValidation(): boolean
Returns boolean
- Defined in packages/type/src/serializer.ts:363

replaceTemplate

replaceTemplate(template: string): void
Parameters
- template: string
Returns void
- Defined in packages/type/src/serializer.ts:377

setContext

setContext(values: {
[name: string]: any;
}): void
Parameters
- values: {
  [name: string]: any;
  }
  - [name: string]: any
Returns void
- Defined in packages/type/src/serializer.ts:482

setVariable

setVariable(name: string, value?: any): string
Parameters
- name: string
- Optional value: any
Returns string
- Defined in packages/type/src/serializer.ts:478

stop

stop(): void
Stop executing next templates.

Returns void
- Defined in packages/type/src/serializer.ts:474

throwCode

throwCode(type: string | Type, error?: string, accessor?: string | ContainerAccessor): string
Parameters
- type: string | Type
- Optional error: string
- accessor: string | ContainerAccessor = ...
Returns string
- Defined in packages/type/src/serializer.ts:449

withValidation

withValidation(validation: undefined | "strict" | "loose"): TemplateState
Parameters
- validation: undefined | "strict" | "loose"
Returns TemplateState
- Defined in packages/type/src/serializer.ts:367

Class TemplateState

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

originalSetter: string | ContainerAccessor

originalAccessor: string | ContainerAccessor

compilerContext: CompilerContext

registry: TemplateRegistry

namingStrategy: NamingStrategy = ...

jitStack: JitStack = ...

path: (string | RuntimeCode)[] = []

Returns TemplateState

Properties

accessor

Optional allSpecificalities

compilerContext

ended

Protected handledAnnotations

jitStack

namingStrategy

originalAccessor

originalSetter

path

Optional propertyName

registry

setter

setterDisabled

target

template

Optional validation

Accessors

isDeserialization

Returns boolean

isSerialization

Returns boolean

Methods

addCode

Parameters

code: string

Returns void

addCodeForSetter

Parameters

code: string

Returns void

addSetter

Parameters

code: string | { toString: any; }

Returns void

addSetterAndReportErrorIfInvalid

Parameters

errorCode: string

message: string

code: string

Returns void

annotationHandled

Parameters

annotation: AnnotationDefinition<any>

Returns void

assignValidationError

Parameters

code: string

message: string

Returns string

disableSetter

Returns TemplateState

enableSetter

Returns TemplateState

extendPath

Parameters

path: string | number | symbol | RuntimeCode

Returns TemplateState

forPropertyName

Parameters

Optional name: string | number | symbol | RuntimeCode

`Optional` allSpecificalities

`Protected` handledAnnotations

`Optional` propertyName

`Optional` validation

code: string | {
toString: any;
}

`Optional` name: string | number | symbol | RuntimeCode

`Optional` setter: string | ContainerAccessor

`Optional` accessor: string | ContainerAccessor

`Optional` path: (string | RuntimeCode)[]

values: {
[name: string]: any;
}

`Optional` value: any

`Optional` error: string