TupleType <Elements, Rest>

Hierarchy

• NodeTrait
  • TupleType

Index

Constructors

• constructor

Properties

• _attributes
• _canReference
• _children
• _connections
• _definition
• _hooks
• _id
• _isCommutative
• _name
• _options
• _sourcePath
• _transform
• _type
• infer
• input
• items

Accessors

• _output

Methods

• array
• compile
• default
• describe
• jsonschema
• nullable
• optional
• reference
• rest
• validator

Constructors

publicconstructor

• new TupleType<Elements, Rest>(elements: ConstExprTuple<Elements>, options: SchemaOptions<TupleOptions<Rest>, TupleToInfer<Elements>>): TupleType<Elements, Rest>

• Overrides NodeTrait.constructor

  Type parameters

  • Elements: [Node, ...Node[]] = [Node, ...Node[]]
  • Rest: undefined | Node = undefined

  Parameters

  • elements: ConstExprTuple<Elements>

  • options: SchemaOptions<TupleOptions<Rest>, TupleToInfer<Elements>>

  Returns TupleType<Elements, Rest>

Properties

public_attributes

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

Inherited from NodeTrait._attributes

Type declaration

• generic: GenericAttributes

• typescript: TypescriptAttributes

publicoptional_canReference

_canReference?: boolean

Inherited from NodeTrait._canReference

public_children

_children: Node[]

Overrides NodeTrait._children

publicoptional_connections

_connections?: Node[]

Inherited from NodeTrait._connections

public_definition

_definition: ThereforeNodeDefinition<Rest extends { infer: unknown } ? [...TupleToInfer<Elements>[], ...Rest<Rest>[infer][]] : TupleToInfer<Elements>> = {}

Inherited from NodeTrait._definition

publicoptional_hooks

_hooks?: Hooks

Inherited from NodeTrait._hooks

public_id

_id: string = ...

Inherited from NodeTrait._id

public_isCommutative

_isCommutative: boolean = false

Overrides NodeTrait._isCommutative

publicoptional_name

_name?: string

Inherited from NodeTrait._name

public_options

_options: TupleOptions<Rest> = {}

publicoptional_sourcePath

_sourcePath?: string

Inherited from NodeTrait._sourcePath

publicoptional_transform

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

Inherited from NodeTrait._transform

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: tuple = ...

Overrides NodeTrait._type

publicinfer

infer: Rest extends { infer: unknown } ? [...TupleToInfer<Elements>[], ...Rest<Rest>[infer][]] : TupleToInfer<Elements>

Overrides NodeTrait.infer

publicinput

input: Rest extends { infer: unknown } ? [...TupleToInput<Elements>[], ...Rest<Rest>[input][]] : TupleToInput<Elements>

Overrides NodeTrait.input

publicitems

items: Node[]

Accessors

public_output

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

• Inherited from NodeTrait._output

  Returns undefined | (TypescriptOutput | GenericOutput)[]

Methods

publicarray

• array(options?: SchemaOptions<ArrayOptions>): ArrayType<TupleType<Elements, Rest>>

• Inherited from NodeTrait.array

  Parameters

  • options: SchemaOptions<ArrayOptions> = {}

  Returns ArrayType<TupleType<Elements, Rest>>

publiccompile

• compile(__namedParameters?: { formats?: boolean }): Schema<Rest extends { infer: unknown } ? [...TupleToInfer<Elements>[], ...Rest<Rest>[infer][]] : TupleToInfer<Elements>>

• Inherited from NodeTrait.compile

  Parameters

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

  • optionalformats: boolean = true

  Returns Schema<Rest extends { infer: unknown } ? [...TupleToInfer<Elements>[], ...Rest<Rest>[infer][]] : TupleToInfer<Elements>>

publicdefault

• default(value: Rest extends { infer: unknown } ? [...TupleToInput<Elements>[], ...Rest<Rest>[input][]] : TupleToInput<Elements>): DefaultType<TupleType<Elements, Rest>>

• Inherited from NodeTrait.default

  Parameters

  • value: Rest extends { infer: unknown } ? [...TupleToInput<Elements>[], ...Rest<Rest>[input][]] : TupleToInput<Elements>

  Returns DefaultType<TupleType<Elements, Rest>>

publicdescribe

• describe(description: string): this

• Inherited from NodeTrait.describe

  Parameters

  • description: string

  Returns this

publicjsonschema

• jsonschema(schema: JsonSchema<Rest extends { infer: unknown } ? [...TupleToInfer<Elements>[], ...Rest<Rest>[infer][]] : TupleToInfer<Elements>>): this

• Inherited from NodeTrait.jsonschema

  Parameters

  • schema: JsonSchema<Rest extends { infer: unknown } ? [...TupleToInfer<Elements>[], ...Rest<Rest>[infer][]] : TupleToInfer<Elements>>

  Returns this

publicnullable

• nullable(): NullableType<TupleType<Elements, Rest>>

• Inherited from NodeTrait.nullable

  Returns NullableType<TupleType<Elements, Rest>>

publicoptional

• optional(): OptionalType<TupleType<Elements, Rest>>

• Inherited from NodeTrait.optional

  Returns OptionalType<TupleType<Elements, Rest>>

publicreference

• reference(options?: SchemaOptions<object>): RefType<TupleType<Elements, Rest>>

• Inherited from NodeTrait.reference

  Parameters

  • options: SchemaOptions<object> = {}

  Returns RefType<TupleType<Elements, Rest>>

publicrest

• rest<T>(rest: ConstExpr<T>): TupleType<Elements, T>

• Type parameters

  • T: Node

  Parameters

  • rest: ConstExpr<T>

  Returns TupleType<Elements, T>

publicvalidator

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

• Inherited from NodeTrait.validator

  Parameters

  • validator: Partial<ValidatorOptions> = {}

  Returns this