Skip to main content

UnionType <Elements>

Hierarchy

  • NodeTrait
    • UnionType

Index

Constructors

Properties

Accessors

Methods

Constructors

publicconstructor

  • new UnionType<Elements>(union: ConstExprTuple<Elements>, options: SchemaOptions<object, ToInfer<Elements>[number]>): UnionType<Elements>

  • Type parameters

    Parameters

    • union: ConstExprTuple<Elements>
    • options: SchemaOptions<object, ToInfer<Elements>[number]>

    Returns UnionType<Elements>

Properties

public_attributes

_attributes: { generic: GenericAttributes; typescript: TypescriptAttributes } = ...

Type declaration

  • generic: GenericAttributes
  • typescript: TypescriptAttributes

publicoptional_canReference

_canReference?: boolean

public_children

_children: Node[]

publicoptional_connections

_connections?: Node[]

public_definition

_definition: ThereforeNodeDefinition<ToInfer<Elements>[number]> = {}

publicoptional_hooks

_hooks?: Hooks

public_id

_id: string = ...

public_isCommutative

_isCommutative: boolean = false

publicoptional_name

_name?: string

public_options

_options: object = {}

publicoptional_sourcePath

_sourcePath?: string

publicoptional_transform

_transform?: { aliasName?: (name: string) => string; referenceName?: (name: string) => string; symbolName?: (name: string) => string }

Type declaration

  • optionalaliasName?: (name: string) => string
      • (name: string): string

      • Parameters

        • name: string

        Returns string

  • optionalreferenceName?: (name: string) => string
      • (name: string): string

      • Parameters

        • name: string

        Returns string

  • optionalsymbolName?: (name: string) => string
      • (name: string): string

      • Parameters

        • name: string

        Returns string

public_type

_type: union = ...

publicinfer

infer: ToInfer<Elements>[number]

publicinput

input: ToInput<Elements>[number]

publicintrinsic

intrinsic: Intrinsic<Elements[number]>

Accessors

public_output

  • get _output(): undefined | (TypescriptOutput | GenericOutput)[]

  • Returns undefined | (TypescriptOutput | GenericOutput)[]

publicoptions

  • get options(): Node[]

Methods

publicarray

publiccompile

  • compile(__namedParameters?: { formats?: boolean }): Schema<ToInfer<Elements>[number]>

  • Parameters

    • __namedParameters: { formats?: boolean } = {}
      • optionalformats: boolean = true

    Returns Schema<ToInfer<Elements>[number]>

publicdefault

  • default(value: ToInput<Elements>[number]): DefaultType<UnionType<Elements>>

  • Parameters

    • value: ToInput<Elements>[number]

    Returns DefaultType<UnionType<Elements>>

publicdescribe

  • describe(description: string): this

  • Parameters

    • description: string

    Returns this

publicjsonschema

  • jsonschema(schema: JsonSchema<ToInfer<Elements>[number]>): this

  • Parameters

    • schema: JsonSchema<ToInfer<Elements>[number]>

    Returns this

publicnullable

  • nullable(): NullableType<UnionType<Elements>>

  • Returns NullableType<UnionType<Elements>>

publicoptional

  • optional(): OptionalType<UnionType<Elements>>

  • Returns OptionalType<UnionType<Elements>>

publicreference

  • Parameters

    Returns RefType<Intrinsic<Elements[number]>>

publicvalidator

  • validator(validator?: Partial<ValidatorOptions>): this

  • Parameters

    • validator: Partial<ValidatorOptions> = {}

    Returns this

Page Options