ArrayType <Element>

Hierarchy

• Node
• NodeTrait
  • ArrayType

Index

Constructors

• constructor

Properties

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

Accessors

• _output

Methods

• arbitrary
• array
• compile
• default
• describe
• jsonschema
• maxItems
• minItems
• nonempty
• nullable
• optional
• reference
• set
• validator

Constructors

publicconstructor

• new ArrayType<Element>(items: ConstExpr<Element>, options: SchemaOptions<ArrayOptions, Element[infer]>): ArrayType<Element>

• Overrides Node.constructor

  Type parameters

  • Element: Node = Node

  Parameters

  • items: ConstExpr<Element>

  • options: SchemaOptions<ArrayOptions, Element[infer]>

  Returns ArrayType<Element>

Properties

public_attributes

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

Inherited from Node._attributes

Type declaration

• generic: GenericAttributes

• typescript: TypescriptAttributes

publicoptional_canReference

_canReference?: boolean

Inherited from Node._canReference

public_children

_children: [Node]

Overrides Node._children

publicoptional_connections

_connections?: Node[]

Inherited from Node._connections

public_definition

_definition: ThereforeNodeDefinition<Element[infer][]> = {}

Inherited from Node._definition

publicoptional_hooks

_hooks?: Hooks

Inherited from Node._hooks

public_id

_id: string = ...

Inherited from Node._id

public_isCommutative

_isCommutative: boolean = false

Overrides Node._isCommutative

publicoptional_name

_name?: string

Inherited from Node._name

public_options

_options: ArrayOptions = {}

publicoptional_sourcePath

_sourcePath?: string

Inherited from Node._sourcePath

publicoptional_transform

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

Inherited from Node._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: array = ...

Overrides Node._type

publicelement

element: Element

publicinfer

infer: Element[infer][]

Overrides Node.infer

publicinput

input: Element[input][]

Overrides Node.input

Accessors

public_output

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

• Inherited from Node._output

  Returns undefined | (TypescriptOutput | GenericOutput)[]

Methods

publicarbitrary

• arbitrary(options: Partial<ArrayGenerator<Element[infer], number>>): ArrayType<Element>

• Parameters

  • options: Partial<ArrayGenerator<Element[infer], number>>

  Returns ArrayType<Element>

publicarray

• array(options?: SchemaOptions<ArrayOptions>): ArrayType<ArrayType<Element>>

• Parameters

  • options: SchemaOptions<ArrayOptions> = {}

  Returns ArrayType<ArrayType<Element>>

publiccompile

• compile(__namedParameters?: { formats?: boolean }): Schema<Element[infer][]>

• Parameters

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

  • optionalformats: boolean = true

  Returns Schema<Element[infer][]>

publicdefault

• default(value: Element[input][]): DefaultType<ArrayType<Element>>

• Inherited from Node.default

  Parameters

  • value: Element[input][]

  Returns DefaultType<ArrayType<Element>>

publicdescribe

• describe(description: string): this

• Inherited from Node.describe

  Parameters

  • description: string

  Returns this

publicjsonschema

• jsonschema(schema: JsonSchema<Element[infer][]>): this

• Inherited from Node.jsonschema

  Parameters

  • schema: JsonSchema<Element[infer][]>

  Returns this

publicmaxItems

• maxItems(maxItems: number): ArrayType<Element>

• Parameters

  • maxItems: number

  Returns ArrayType<Element>

publicminItems

• minItems(minItems: number): ArrayType<Element>

• Parameters

  • minItems: number

  Returns ArrayType<Element>

publicnonempty

• nonempty(): ArrayType<Element>

• Returns ArrayType<Element>

publicnullable

• nullable(): NullableType<ArrayType<Element>>

• Returns NullableType<ArrayType<Element>>

publicoptional

• optional(): OptionalType<ArrayType<Element>>

• Returns OptionalType<ArrayType<Element>>

publicreference

• reference(options?: SchemaOptions<object>): RefType<ArrayType<Element>>

• Parameters

  • options: SchemaOptions<object> = {}

  Returns RefType<ArrayType<Element>>

publicset

• set(): ArrayType<Element>

• Returns ArrayType<Element>

publicvalidator

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

• Inherited from Node.validator

  Parameters

  • validator: Partial<ValidatorOptions> = {}

  Returns this