Class Changeset<T, M>

Type parameters

T: Record<string, any>
M = any

Hierarchy

Factory<IChangeset<T>>
Record<IChangeset<any>, this> & Readonly<IChangeset<any>>
- Changeset

Callable

Changeset(values?: Iterable<[string, unknown]> | Partial<IChangeset<T>>): Record<IChangeset<T>> & Readonly<IChangeset<T>>

- Defined in node_modules/immutable/dist/immutable.d.ts:2481
Parameters
- Optional values: Iterable<[string, unknown]> | Partial<IChangeset<T>>
Returns Record<IChangeset<T>> & Readonly<IChangeset<T>>

Constructors

constructor

new Changeset<T, M>(defaults: Partial<T> | Iterable<[keyof T, ValueOf<T>]>): Changeset<T, M>

Inherited from ImmutableRecord.Factory<IChangeset<T>>.constructor
- Defined in src/Changeset.ts:121
Type parameters
- T: Record<string, any>
- M = any
Parameters
- defaults: Partial<T> | Iterable<[keyof T, ValueOf<T>]>
Returns Changeset<T, M>

constructor

new Changeset(values?: Iterable<[string, unknown]> | Partial<IChangeset<T>>): Record<IChangeset<T>> & Readonly<IChangeset<T>>

Inherited from ImmutableRecord.Factory<IChangeset<T>>.constructor
- Defined in node_modules/immutable/dist/immutable.d.ts:2483
Parameters
- Optional values: Iterable<[string, unknown]> | Partial<IChangeset<T>>
Returns Record<IChangeset<T>> & Readonly<IChangeset<T>>

Properties

Readonly changes

changes: IChanges<any>

Readonly defaults

defaults: IChanges<any>

Readonly errors

errors: IChangesetErrors<any, any>

Readonly modified

modified: IModified<any>

Readonly valid

valid: boolean

Methods

addChange

addChange<K>(field: K, value?: T[K]): Changeset<T, M>

- Defined in src/Changeset.ts:202
Type parameters
- K: string | number | symbol
Parameters
- field: K
- Optional value: T[K]
Returns Changeset<T, M>

addChanges

addChanges(newChanges: Partial<T>): Changeset<T, M>

- Defined in src/Changeset.ts:208
Parameters
- newChanges: Partial<T>
Returns Changeset<T, M>

addDefault

addDefault<K>(field: K, value?: T[K]): Changeset<T, M>

- Defined in src/Changeset.ts:215
Type parameters
- K: string | number | symbol
Parameters
- field: K
- Optional value: T[K]
Returns Changeset<T, M>

addDefaults

addDefaults(defaults: Partial<T>): Changeset<T, M>

- Defined in src/Changeset.ts:219
Parameters
- defaults: Partial<T>
Returns Changeset<T, M>

addError

addError(field: keyof T, message: string, values?: any[], meta?: M): Changeset<T, M>

- Defined in src/Changeset.ts:188
Parameters
- field: keyof T
- message: string
- values: any[] = []
- Optional meta: M
Returns Changeset<T, M>

applyChanges

applyChanges(): IChanges<T>

- Defined in src/Changeset.ts:184
Returns IChanges<T>

clear

clear(): Changeset<T, M>

- Defined in src/Changeset.ts:238
Returns Changeset<T, M>

clearChanges

clearChanges(): Changeset<T, M>

- Defined in src/Changeset.ts:230
Returns Changeset<T, M>

clearDefaults

clearDefaults(): Changeset<T, M>

- Defined in src/Changeset.ts:234
Returns Changeset<T, M>

clearErrors

clearErrors(): Changeset<T, M>

- Defined in src/Changeset.ts:226
Returns Changeset<T, M>

filter

filter(fields: keyof T[]): Changeset<T, M>

- Defined in src/Changeset.ts:242
Parameters
- fields: keyof T[]
Returns Changeset<T, M>

getChange

getChange<K>(field: K, defaultValue?: T[K]): undefined | T[K]

- Defined in src/Changeset.ts:146
Type parameters
- K: string | number | symbol
Parameters
- field: K
- Optional defaultValue: T[K]
Returns undefined | T[K]

getChanges

getChanges(): IChanges<T>

- Defined in src/Changeset.ts:176
Returns IChanges<T>

getDefault

getDefault<K>(field: K, defaultValue?: T[K]): undefined | T[K]

- Defined in src/Changeset.ts:139
Type parameters
- K: string | number | symbol
Parameters
- field: K
- Optional defaultValue: T[K]
Returns undefined | T[K]

getDefaults

getDefaults(): IChanges<T>

- Defined in src/Changeset.ts:172
Returns IChanges<T>

getErrorList

getErrorList(field: keyof T): List<RecordOf<IChangesetError<M>>>

- Defined in src/Changeset.ts:164
Parameters
- field: keyof T
Returns List<RecordOf<IChangesetError<M>>>

getErrors

getErrors(): IChangesetErrors<T, M>

- Defined in src/Changeset.ts:168
Returns IChangesetErrors<T, M>

getField

getField<K>(field: K, defaultValue?: T[K]): undefined | T[K]

- Defined in src/Changeset.ts:153
Type parameters
- K: string | number | symbol
Parameters
- field: K
- Optional defaultValue: T[K]
Returns undefined | T[K]

getFields

getFields(): IChanges<T>

- Defined in src/Changeset.ts:180
Returns IChanges<T>

getModified

getModified(field: keyof T): boolean

- Defined in src/Changeset.ts:160
Parameters
- field: keyof T
Returns boolean

hasChange

hasChange(field: keyof T): boolean

- Defined in src/Changeset.ts:135
Parameters
- field: keyof T
Returns boolean

isInvalid

isInvalid(): boolean

- Defined in src/Changeset.ts:131
Returns boolean

isValid

isValid(): boolean

- Defined in src/Changeset.ts:127
Returns boolean

validate

validate(validator: (changeset: Changeset<T, M>) => Changeset<T, M>): Changeset<T, M>

- Defined in src/Changeset.ts:259
Parameters
- validator: (changeset: Changeset<T, M>) => Changeset<T, M>
  - - (changeset: Changeset<T, M>): Changeset<T, M>
    - Parameters
      - changeset: Changeset<T, M>
      Returns Changeset<T, M>
Returns Changeset<T, M>

validateAcceptance

validateAcceptance(field: keyof T): Changeset<T, M>

- Defined in src/Changeset.ts:262
Parameters
- field: keyof T
Returns Changeset<T, M>

validateFormat

validateFormat(field: keyof T, regex: RegExp): Changeset<T, M>

- Defined in src/Changeset.ts:280
Parameters
- field: keyof T
- regex: RegExp
Returns Changeset<T, M>

validateLength

validateLength(field: keyof T, opts?: {}): Changeset<T, M>

- Defined in src/Changeset.ts:267
Parameters
- field: keyof T
- opts: {} = {}
  - [key: string]: number
Returns Changeset<T, M>

validateRequired

validateRequired(values: keyof T[]): Changeset<T, M>

- Defined in src/Changeset.ts:275
Parameters
- values: keyof T[]
Returns Changeset<T, M>

Static validateAcceptance

validateAcceptance<T, M>(changeset: Changeset<T, M>, field: keyof T): Changeset<T, M>

- Defined in src/Changeset.ts:50
Type parameters
- T: Record<string, any>
- M = any
Parameters
- changeset: Changeset<T, M>
- field: keyof T
Returns Changeset<T, M>

Static validateFormat

validateFormat<T, M>(changeset: Changeset<T, M>, field: keyof T, regex: RegExp): Changeset<T, M>

- Defined in src/Changeset.ts:107
Type parameters
- T: Record<string, any>
- M = any
Parameters
- changeset: Changeset<T, M>
- field: keyof T
- regex: RegExp
Returns Changeset<T, M>

Static validateLength

validateLength<T, M>(changeset: Changeset<T, M>, field: keyof T, opts?: {}): Changeset<T, M>

- Defined in src/Changeset.ts:63
Type parameters
- T: Record<string, any>
- M = any
Parameters
- changeset: Changeset<T, M>
- field: keyof T
- opts: {} = {}
  - [key: string]: number
Returns Changeset<T, M>

Static validateRequired

validateRequired<T, M>(changeset: Changeset<T, M>, values: keyof T[]): Changeset<T, M>

- Defined in src/Changeset.ts:92
Type parameters
- T: Record<string, any>
- M = any
Parameters
- changeset: Changeset<T, M>
- values: keyof T[]
Returns Changeset<T, M>

Generated using TypeDoc