RefType <Reference>

Hierarchy

• Node
• NodeTrait
  • RefType

Index

Constructors

• constructor

Properties

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

Accessors

• _output
• item

Methods

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

Constructors

publicconstructor

• new RefType<Reference>(reference: ConstExpr<Reference>, options: SchemaOptions<object, Reference[infer]>): RefType<Reference>

• Overrides Node.constructor

  Type parameters

  • Reference: Node = Node

  Parameters

  • reference: ConstExpr<Reference>

  • options: SchemaOptions<object, Reference[infer]>

  Returns RefType<Reference>

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<Reference[infer]> = {}

Inherited from Node._definition

public_hooks

_hooks: { onGenerate: (__namedParameters: Node) => void[]; onLoad: (self: Node) => void[] } = ...

Overrides Node._hooks

Type declaration

• onGenerate: (__namedParameters: Node) => void[]

• onLoad: (self: Node) => void[]

public_id

_id: string = ...

Inherited from Node._id

public_isCommutative

_isCommutative: boolean = true

Inherited from Node._isCommutative

publicoptional_name

_name?: string

Inherited from Node._name

public_options

_options: object = {}

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

Overrides Node._type

publicinfer

infer: Reference[infer]

Overrides Node.infer

publicinput

input: Reference[input]

Overrides Node.input

publicintrinsic

intrinsic: Intrinsic<Reference>

Accessors

public_output

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

• Inherited from Node._output

  Returns undefined | (TypescriptOutput | GenericOutput)[]

publicitem

• get item(): Reference

• Returns Reference

Methods

publicarray

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

• Parameters

  • options: SchemaOptions<ArrayOptions> = {}

  Returns ArrayType<RefType<Reference>>

publiccompile

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

• Parameters

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

  • optionalformats: boolean = true

  Returns Schema<Reference[infer]>

publicdefault

• default(value: Reference[input]): DefaultType<RefType<Reference>>

• Inherited from Node.default

  Parameters

  • value: Reference[input]

  Returns DefaultType<RefType<Reference>>

publicdescribe

• describe(description: string): this

• Inherited from Node.describe

  Parameters

  • description: string

  Returns this

publicjsonschema

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

• Inherited from Node.jsonschema

  Parameters

  • schema: JsonSchema<Reference[infer]>

  Returns this

publicnullable

• nullable(): NullableType<RefType<Reference>>

• Returns NullableType<RefType<Reference>>

publicoptional

• optional(): OptionalType<RefType<Reference>>

• Returns OptionalType<RefType<Reference>>

publicreference

• reference(options?: SchemaOptions<object>): RefType<Intrinsic<Reference>>

• Parameters

  • options: SchemaOptions<object> = {}

  Returns RefType<Intrinsic<Reference>>

publicvalidator

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

• Inherited from Node.validator

  Parameters

  • validator: Partial<ValidatorOptions> = {}

  Returns this

publicstatic_from

• _from<Reference>(ref: ConstExpr<Reference>, options: SchemaOptions<object>): RefType<Intrinsic<Reference>>

• Type parameters

  • Reference: Node

  Parameters

  • ref: ConstExpr<Reference>

  • options: SchemaOptions<object>

  Returns RefType<Intrinsic<Reference>>