Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Schema

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly rules

rules: List<Rule>

Static displayName

displayName: string

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

Accessors

Private __form_blueprint_schema__

  • get __form_blueprint_schema__(): boolean

kind

  • get kind(): string

Methods

[iterator]

  • [iterator](): IterableIterator<["rules", List<Rule>]>

  • Returns IterableIterator<["rules", List<Rule>]>

addRule

asImmutable

  • see

    Map#asImmutable

    Returns Schema

asMutable

  • see

    Map#asMutable

    Returns Schema

clear

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

    Returns Schema

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

    • K: "rules"

    Parameters

    • key: K

    Returns Schema

deleteIn

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

    removeIn

    Parameters

    • keyPath: Iterable<unknown>

    Returns Schema

equals

  • equals(other: unknown): boolean

  • Parameters

    • other: unknown

    Returns boolean

get

  • get<K>(key: K, notSetValue?: unknown): SchemaRecord[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

    • K: "rules"

    Parameters

    • key: K
    • Optional notSetValue: unknown

    Returns SchemaRecord[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 "rules"

  • Parameters

    • key: string

    Returns key is "rules"

hasIn

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

  • Parameters

    • keyPath: Iterable<unknown>

    Returns boolean

hashCode

  • hashCode(): number

  • Returns number

join

merge

  • Parameters

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

    Returns Schema

mergeDeep

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

  • Parameters

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

    Returns Schema

mergeDeepIn

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

  • Parameters

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

    Returns Schema

mergeDeepWith

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

  • 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<SchemaRecord>)[]

    Returns Schema

mergeIn

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

  • Parameters

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

    Returns Schema

mergeWith

  • mergeWith(merger: (oldVal: unknown, newVal: unknown, key: "rules") => unknown, ...collections: (Iterable<[string, unknown]> | Partial<SchemaRecord>)[]): Schema

  • Parameters

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

        • Parameters

          • oldVal: unknown
          • newVal: unknown
          • key: "rules"

          Returns unknown

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

    Returns Schema

normalize

reduce

  • reduce<T>(fn: (memo: T, rule: Rule) => T, initial: T): T
  • reduce<T>(fn: (memo: undefined | T, rule: Rule) => undefined | T, initial?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • fn: (memo: T, rule: Rule) => T
        • (memo: T, rule: Rule): T

        • Parameters

          Returns T

    • initial: T

    Returns T

  • Type parameters

    • T

    Parameters

    • fn: (memo: undefined | T, rule: Rule) => undefined | T
        • (memo: undefined | T, rule: Rule): undefined | T

        • Parameters

          • memo: undefined | T
          • rule: Rule

          Returns undefined | T

    • Optional initial: T

    Returns undefined | T

remove

  • Type parameters

    • K: "rules"

    Parameters

    • key: K

    Returns Schema

removeIn

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

  • Parameters

    • keyPath: Iterable<unknown>

    Returns Schema

serialize

set

  • Type parameters

    • K: "rules"

    Parameters

    Returns Schema

setIn

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

  • Parameters

    • keyPath: Iterable<unknown>
    • value: unknown

    Returns Schema

toJS

  • toJS(): { rules: 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 { rules: unknown }

    • rules: unknown

toJSON

  • Shallowly converts this Record to equivalent native JavaScript Object.

    Returns SchemaRecord

toObject

  • Shallowly converts this Record to equivalent JavaScript Object.

    Returns SchemaRecord

toSeq

  • toSeq(): Keyed<"rules", List<Rule>>

  • Returns Keyed<"rules", List<Rule>>

transform

  • transform(field: Field, value?: any): any

update

updateIn

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

  • Parameters

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

        • Parameters

          • value: unknown

          Returns unknown

    Returns Schema

wasAltered

  • wasAltered(): boolean
  • see

    Map#wasAltered

    Returns boolean

withMutations

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

  • 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: Schema) => unknown

        • Parameters

          Returns unknown

    Returns Schema

Static create

Static defaultJoin

Static isSchema

Generated using TypeDoc