RecordType <IndexType>

Hierarchy

• ObjectType
  • RecordType

Index

Constructors

• constructor

Properties

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

Accessors

• _output

Methods

• _from
• array
• compile
• default
• describe
• extend
• jsonschema
• keyof
• merge
• nullable
• omit
• optional
• partial
• pick
• reference
• required
• strict
• validator

Constructors

publicconstructor

• new RecordType<IndexType>(recordType: ThereforeExpr, options: SchemaOptions<object, Record<string, IndexType[infer]>>): RecordType<IndexType>

• Overrides ObjectType.constructor

  Type parameters

  • IndexType: Node = Node

  Parameters

  • recordType: ThereforeExpr

  • options: SchemaOptions<object, Record<string, IndexType[infer]>>

  Returns RecordType<IndexType>

Properties

public_attributes

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

Inherited from ObjectType._attributes

Type declaration

• generic: GenericAttributes

• typescript: TypescriptAttributes

publicoptional_canReference

_canReference?: boolean

Inherited from ObjectType._canReference

public_children

_children: Node[]

Inherited from ObjectType._children

publicoptional_connections

_connections?: Node[]

Inherited from ObjectType._connections

public_definition

_definition: ThereforeNodeDefinition<Record<string, IndexType[infer]>> = {}

Inherited from ObjectType._definition

publicoptional_hooks

_hooks?: Hooks

Inherited from ObjectType._hooks

public_id

_id: string = ...

Inherited from ObjectType._id

public_isCommutative

_isCommutative: boolean = false

Inherited from ObjectType._isCommutative

publicoptional_name

_name?: string

Inherited from ObjectType._name

public_options

_options: ObjectOptions

Inherited from ObjectType._options

publicoptional_sourcePath

_sourcePath?: string

Inherited from ObjectType._sourcePath

publicoptional_transform

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

Inherited from ObjectType._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: object = ...

Inherited from ObjectType._type

publicelement

element: IndexType

Overrides ObjectType.element

publicinfer

infer: Record<string, IndexType[infer]>

Overrides ObjectType.infer

publicinput

input: Record<string, IndexType[input]>

Overrides ObjectType.input

publicshape

shape: {}

Inherited from ObjectType.shape

Type declaration

Accessors

public_output

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

• Inherited from ObjectType._output

  Returns (TypescriptOutput | GenericOutput)[]

Methods

public_from

• _from(__namedParameters: { patternProperties?: Record<string, ThereforeExpr>; recordType?: ThereforeExpr; shape?: ObjectShape<Record<string, Node>> }): void

• Inherited from ObjectType._from

  Parameters

  • __namedParameters: { patternProperties?: Record<string, ThereforeExpr>; recordType?: ThereforeExpr; shape?: ObjectShape<Record<string, Node>> }

  • optionalpatternProperties: Record<string, ThereforeExpr> = ...

  • optionalrecordType: ThereforeExpr = ...

  • optionalshape: ObjectShape<Record<string, Node>> = ...

  Returns void

publicarray

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

• Inherited from ObjectType.array

  Parameters

  • options: SchemaOptions<ArrayOptions> = {}

  Returns ArrayType<RecordType<IndexType>>

publiccompile

• compile(__namedParameters?: { formats?: boolean }): Schema<Record<string, IndexType[infer]>>

• Inherited from ObjectType.compile

  Parameters

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

  • optionalformats: boolean = true

  Returns Schema<Record<string, IndexType[infer]>>

publicdefault

• default(value: Record<string, IndexType[input]>): DefaultType<RecordType<IndexType>>

• Inherited from ObjectType.default

  Parameters

  • value: Record<string, IndexType[input]>

  Returns DefaultType<RecordType<IndexType>>

publicdescribe

• describe(description: string): this

• Inherited from ObjectType.describe

  Parameters

  • description: string

  Returns this

publicextend

• extend<Extra>(extra: ObjectShape<Extra>): ObjectType<{ [ KeyType in string | number | symbol ]: Record<string, Node> & Extra[KeyType] }>

• Inherited from ObjectType.extend

  Type parameters

  • Extra: Record<string, Node>

  Parameters

  • extra: ObjectShape<Extra>

  Returns ObjectType<{ [ KeyType in string | number | symbol ]: Record<string, Node> & Extra[KeyType] }>

publicjsonschema

• jsonschema(schema: JsonSchema<Record<string, IndexType[infer]>>): this

• Inherited from ObjectType.jsonschema

  Parameters

  • schema: JsonSchema<Record<string, IndexType[infer]>>

  Returns this

publickeyof

• keyof(): EnumType<string[]>

• Inherited from ObjectType.keyof

  Returns EnumType<string[]>

publicmerge

• merge<Other>(other: Other): ObjectType<{ [ KeyType in string | number | symbol ]: Record<string, Node> & Other[shape][KeyType] }>

• Inherited from ObjectType.merge

  Type parameters

  • Other: ObjectType<Record<string, Node>>

  Parameters

  • other: Other

  Returns ObjectType<{ [ KeyType in string | number | symbol ]: Record<string, Node> & Other[shape][KeyType] }>

publicnullable

• nullable(): NullableType<RecordType<IndexType>>

• Inherited from ObjectType.nullable

  Returns NullableType<RecordType<IndexType>>

publicomit

• omit<Key>(...properties: Key[]): ObjectType<{ [ KeyType in string ]: Omit<Record<string, Node>, Key>[KeyType] }>

• Inherited from ObjectType.omit

  Type parameters

  • Key: string

  Parameters

  • rest...properties: Key[]

  Returns ObjectType<{ [ KeyType in string ]: Omit<Record<string, Node>, Key>[KeyType] }>

publicoptional

• optional(): OptionalType<RecordType<IndexType>>

• Inherited from ObjectType.optional

  Returns OptionalType<RecordType<IndexType>>

publicpartial

• partial<Keys>(...properties: Keys): ObjectType<ShapeToPartial<Record<string, Node>, Keys>>

• Inherited from ObjectType.partial

  Type parameters

  • Keys: string[]

  Parameters

  • rest...properties: Keys

  Returns ObjectType<ShapeToPartial<Record<string, Node>, Keys>>

publicpick

• pick<Key>(...properties: Key[]): ObjectType<{ [ KeyType in string ]: Pick<Record<string, Node>, Key>[KeyType] }>

• Inherited from ObjectType.pick

  Type parameters

  • Key: string

  Parameters

  • rest...properties: Key[]

  Returns ObjectType<{ [ KeyType in string ]: Pick<Record<string, Node>, Key>[KeyType] }>

publicreference

• reference(options?: SchemaOptions<object>): RefType<RecordType<IndexType>>

• Inherited from ObjectType.reference

  Parameters

  • options: SchemaOptions<object> = {}

  Returns RefType<RecordType<IndexType>>

publicrequired

• required<Keys>(...properties: Keys): ObjectType<ShapeToRequired<Record<string, Node>, Keys>>

• Inherited from ObjectType.required

  Type parameters

  • Keys: string[]

  Parameters

  • rest...properties: Keys

  Returns ObjectType<ShapeToRequired<Record<string, Node>, Keys>>

publicstrict

• strict(strict?: boolean): this

• Inherited from ObjectType.strict

  Parameters

  • strict: boolean = true

  Returns this

publicvalidator

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

• Inherited from ObjectType.validator

  Parameters

  • validator: Partial<ValidatorOptions> = {}

  Returns this