ObjectType <Shape>

Hierarchy

• NodeTrait
  • ObjectType
    • RecordType

Index

Constructors

• constructor

Properties

• _attributes
• _canReference
• _children
• _connections
• _definition
• _hooks
• _id
• _isCommutative
• _name
• _options
• _sourcePath
• _transform
• _type
• 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 ObjectType<Shape>(shape: ObjectShape<Shape>, options: SchemaOptions<ObjectOptions, { [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }>): ObjectType<Shape>

• Overrides NodeTrait.constructor

  Type parameters

  • Shape: Record<string, Node> = Record<string, Node>

  Parameters

  • shape: ObjectShape<Shape>

  • options: SchemaOptions<ObjectOptions, { [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }>

  Returns ObjectType<Shape>

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<{ [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }> = {}

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: ObjectOptions

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

Overrides NodeTrait._type

publicinfer

infer: { [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }

Overrides NodeTrait.infer

publicinput

input: { [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][input] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][input] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][input] }>[KeyType] }

Overrides NodeTrait.input

publicshape

shape: { [ K in string | number | symbol ]: Shape[K] }

Accessors

public_output

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

• Overrides NodeTrait._output

  Returns (TypescriptOutput | GenericOutput)[]

Methods

public_from

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

• Parameters

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

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

  • optionalrecordType: ThereforeExpr = ...

  • optionalshape: ObjectShape<Shape> = ...

  Returns void

publicarray

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

• Inherited from NodeTrait.array

  Parameters

  • options: SchemaOptions<ArrayOptions> = {}

  Returns ArrayType<ObjectType<Shape>>

publiccompile

• compile(__namedParameters?: { formats?: boolean }): Schema<{ [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }>

• Inherited from NodeTrait.compile

  Parameters

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

  • optionalformats: boolean = true

  Returns Schema<{ [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }>

publicdefault

• default(value: { [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][input] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][input] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][input] }>[KeyType] }): DefaultType<ObjectType<Shape>>

• Inherited from NodeTrait.default

  Parameters

  • value: { [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][input] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][input] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][input] }>[KeyType] }

  Returns DefaultType<ObjectType<Shape>>

publicdescribe

• describe(description: string): this

• Inherited from NodeTrait.describe

  Parameters

  • description: string

  Returns this

publicextend

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

• Type parameters

  • Extra: Record<string, Node>

  Parameters

  • extra: ObjectShape<Extra>

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

publicjsonschema

• jsonschema(schema: JsonSchema<{ [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }>): this

• Inherited from NodeTrait.jsonschema

  Parameters

  • schema: JsonSchema<{ [ KeyType in string | number | symbol ]: Omit<{ [ K in string | number | symbol ]: Shape[K][infer] }, keyof UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>> & UndefinedToOptional<{ [ K in string | number | symbol ]: Shape[K][infer] }>[KeyType] }>

  Returns this

publickeyof

• keyof(): EnumType<keyof Shape[]>

• Returns EnumType<keyof Shape[]>

publicmerge

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

• Type parameters

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

  Parameters

  • other: Other

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

publicnullable

• nullable(): NullableType<ObjectType<Shape>>

• Inherited from NodeTrait.nullable

  Returns NullableType<ObjectType<Shape>>

publicomit

• omit<Key>(...properties: Key[]): ObjectType<{ [ KeyType in string | number | symbol ]: Omit<Shape, Key>[KeyType] }>

• Type parameters

  • Key: string | number | symbol

  Parameters

  • rest...properties: Key[]

  Returns ObjectType<{ [ KeyType in string | number | symbol ]: Omit<Shape, Key>[KeyType] }>

publicoptional

• optional(): OptionalType<ObjectType<Shape>>

• Inherited from NodeTrait.optional

  Returns OptionalType<ObjectType<Shape>>

publicpartial

• partial<Keys>(...properties: Keys): ObjectType<ShapeToPartial<Shape, Keys>>

• Type parameters

  • Keys: keyof Shape[]

  Parameters

  • rest...properties: Keys

  Returns ObjectType<ShapeToPartial<Shape, Keys>>

publicpick

• pick<Key>(...properties: Key[]): ObjectType<{ [ KeyType in string | number | symbol ]: Pick<Shape, Key>[KeyType] }>

• Type parameters

  • Key: string | number | symbol

  Parameters

  • rest...properties: Key[]

  Returns ObjectType<{ [ KeyType in string | number | symbol ]: Pick<Shape, Key>[KeyType] }>

publicreference

• reference(options?: SchemaOptions<object>): RefType<ObjectType<Shape>>

• Inherited from NodeTrait.reference

  Parameters

  • options: SchemaOptions<object> = {}

  Returns RefType<ObjectType<Shape>>

publicrequired

• required<Keys>(...properties: Keys): ObjectType<ShapeToRequired<Shape, Keys>>

• Type parameters

  • Keys: keyof Shape[]

  Parameters

  • rest...properties: Keys

  Returns ObjectType<ShapeToRequired<Shape, Keys>>

publicstrict

• strict(strict?: boolean): this

• Parameters

  • strict: boolean = true

  Returns this

publicvalidator

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

• Inherited from NodeTrait.validator

  Parameters

  • validator: Partial<ValidatorOptions> = {}

  Returns this