Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Field

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly children

children: List<Field>

Optional Readonly key

key?: string

Readonly props

props: Map<string, any>

Optional Readonly type

type?: string

Static displayName

displayName: string

The name provided to Record(values, name) can be accessed with displayName.

Accessors

Private __form_blueprint_field__

  • get __form_blueprint_field__(): boolean

kind

  • get kind(): string

Methods

[iterator]

  • [iterator](): IterableIterator<[keyof FieldRecord, undefined | string | List<Field> | Map<string, any>]>

  • Returns IterableIterator<[keyof FieldRecord, undefined | string | List<Field> | Map<string, any>]>

asImmutable

  • see

    Map#asImmutable

    Returns Field

asMutable

  • see

    Map#asMutable

    Returns Field

clear

  • Returns a new instance of this Record type with all values set to their default values.

    Returns Field

delete

  • Returns a new instance of this Record type with the value for the specific key set to its default value.

    alias

    remove

    Type parameters

    Parameters

    • key: K

    Returns Field

deleteIn

  • deleteIn(keyPath: Iterable<unknown>): Field
  • alias

    removeIn

    Parameters

    • keyPath: Iterable<unknown>

    Returns Field

equals

  • equals(other: unknown): boolean

  • Parameters

    • other: unknown

    Returns boolean

findChildByKey

  • findChildByKey(key?: string): undefined | Field

get

  • get<K>(key: K, notSetValue?: unknown): FieldRecord[K]
  • get<T>(key: string, notSetValue: T): T

  • Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

    If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

    Type parameters

    Parameters

    • key: K
    • Optional notSetValue: unknown

    Returns FieldRecord[K]

  • Type parameters

    • T

    Parameters

    • key: string
    • notSetValue: T

    Returns T

getIn

  • getIn(keyPath: Iterable<unknown>): unknown

  • Parameters

    • keyPath: Iterable<unknown>

    Returns unknown

has

  • has(key: string): key is "key" | "type" | "children" | "props"

  • Parameters

    • key: string

    Returns key is "key" | "type" | "children" | "props"

hasIn

  • hasIn(keyPath: Iterable<unknown>): boolean

  • Parameters

    • keyPath: Iterable<unknown>

    Returns boolean

hashCode

  • hashCode(): number

  • Returns number

merge

  • merge(...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]): Field

  • Parameters

    • Rest ...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]

    Returns Field

mergeDeep

  • mergeDeep(...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]): Field

  • Parameters

    • Rest ...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]

    Returns Field

mergeDeepIn

  • mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): Field

  • Parameters

    • keyPath: Iterable<unknown>
    • Rest ...collections: unknown[]

    Returns Field

mergeDeepWith

  • mergeDeepWith(merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown, ...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]): Field

  • Parameters

    • merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown
        • (oldVal: unknown, newVal: unknown, key: unknown): unknown

        • Parameters

          • oldVal: unknown
          • newVal: unknown
          • key: unknown

          Returns unknown

    • Rest ...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]

    Returns Field

mergeIn

  • mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): Field

  • Parameters

    • keyPath: Iterable<unknown>
    • Rest ...collections: unknown[]

    Returns Field

mergeWith

  • mergeWith(merger: (oldVal: unknown, newVal: unknown, key: keyof FieldRecord) => unknown, ...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]): Field

  • Parameters

    • merger: (oldVal: unknown, newVal: unknown, key: keyof FieldRecord) => unknown
        • (oldVal: unknown, newVal: unknown, key: keyof FieldRecord): unknown

        • Parameters

          Returns unknown

    • Rest ...collections: (Iterable<[string, unknown]> | Partial<FieldRecord>)[]

    Returns Field

remove

  • Type parameters

    Parameters

    • key: K

    Returns Field

removeIn

  • removeIn(keyPath: Iterable<unknown>): Field

  • Parameters

    • keyPath: Iterable<unknown>

    Returns Field

serialize

  • Convert this field back into an object that can be stringified or passed back to Field.create().

    Returns FieldCreate

set

  • Type parameters

    Parameters

    Returns Field

setIn

  • setIn(keyPath: Iterable<unknown>, value: unknown): Field

  • Parameters

    • keyPath: Iterable<unknown>
    • value: unknown

    Returns Field

toJS

  • toJS(): { children: unknown; key?: unknown; props: unknown; type?: unknown }

  • Deeply converts this Record to equivalent native JavaScript Object.

    Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

    Returns { children: unknown; key?: unknown; props: unknown; type?: unknown }

    • children: unknown
    • Optional key?: unknown
    • props: unknown
    • Optional type?: unknown

toJSON

  • Shallowly converts this Record to equivalent native JavaScript Object.

    Returns FieldRecord

toObject

  • Shallowly converts this Record to equivalent JavaScript Object.

    Returns FieldRecord

toSeq

  • toSeq(): Keyed<keyof FieldRecord, undefined | string | List<Field> | Map<string, any>>

  • Returns Keyed<keyof FieldRecord, undefined | string | List<Field> | Map<string, any>>

update

updateIn

  • updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): Field

  • Parameters

    • keyPath: Iterable<unknown>
    • updater: (value: unknown) => unknown
        • (value: unknown): unknown

        • Parameters

          • value: unknown

          Returns unknown

    Returns Field

wasAltered

  • wasAltered(): boolean
  • see

    Map#wasAltered

    Returns boolean

withMutations

  • withMutations(mutator: (mutable: Field) => unknown): Field

  • Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.

    see

    Map#withMutations

    Parameters

    • mutator: (mutable: Field) => unknown
        • (mutable: Field): unknown

        • Parameters

          Returns unknown

    Returns Field

Static create

Static createList

Static isField

  • isField(b: any): b is Field

Static mergeChildren

  • mergeChildren(mergeFields: (...fields: Field[]) => Field, ...lists: (undefined | null | Field | Iterable<undefined | null | Field>)[]): List<Field>

Generated using TypeDoc