Class Field<T>

constructor

• new Field<T extends DataType<Type, any> = any>(
      name: string,
      type: T,
      nullable?: boolean,
      metadata?: Map<string, string> | null,
  ): Field<T>

  Type Parameters

  • T extends DataType<Type, any> = any

  Parameters

  • name: string
  • type: T
  • nullable: boolean = false
  • Optionalmetadata: Map<string, string> | null

  Returns Field<T>

Readonly Internal[kFieldSymbol]

Readonlymetadata

Readonlyname

Readonlynullable

Readonlytype

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

typeId

• get typeId(): Type

  Returns Type

clone

• clone<R extends DataType<Type, any> = T>(
      props: {
          metadata?: Map<string, string> | null;
          name?: string | number;
          nullable?: boolean;
          type?: R;
      },
  ): Field<R>

  Type Parameters

  • R extends DataType<Type, any> = T

  Parameters

  • props: {
        metadata?: Map<string, string> | null;
        name?: string | number;
        nullable?: boolean;
        type?: R;
    }

  Returns Field<R>

• clone<R extends DataType<Type, any> = T>(
      name?: string | number | Field<T>,
      type?: R,
      nullable?: boolean,
      metadata?: Map<string, string> | null,
  ): Field<R>

  Type Parameters

  • R extends DataType<Type, any> = T

  Parameters

  • Optionalname: string | number | Field<T>
  • Optionaltype: R
  • Optionalnullable: boolean
  • Optionalmetadata: Map<string, string> | null

  Returns Field<R>

toString

• toString(): string

  Returns string

StaticisField

• isField(x: any): x is Field<any>

  Parameters

  • x: any

  Returns x is Field<any>

  Nocollapse

Staticnew

• new<T extends DataType<Type, any> = any>(
      props: {
          metadata?: Map<string, string> | null;
          name: string | number;
          nullable?: boolean;
          type: T;
      },
  ): Field<T>

  Type Parameters

  • T extends DataType<Type, any> = any

  Parameters

  • props: {
        metadata?: Map<string, string> | null;
        name: string | number;
        nullable?: boolean;
        type: T;
    }

  Returns Field<T>

• new<T extends DataType<Type, any> = any>(
      name: string | number | Field<T>,
      type: T,
      nullable?: boolean,
      metadata?: Map<string, string> | null,
  ): Field<T>

  Type Parameters

  • T extends DataType<Type, any> = any

  Parameters

  • name: string | number | Field<T>
  • type: T
  • Optionalnullable: boolean
  • Optionalmetadata: Map<string, string> | null

  Returns Field<T>