Class ImmerChangeset<T>

A class that represents a changeset for a given data object. It uses Immer to create a draft of the data object and track changes made to it. The changes can be applied, reverted, validated, and saved.

Type Parameters

T extends Record<string, any> = Record<string, any>

Implements

Changeset<T>

Index

Constructors

constructor

new ImmerChangeset<T>(data): ImmerChangeset<T>
Type Parameters
- T extends Record<string, any> = Record<string, any>
Parameters
- data: T
Returns ImmerChangeset<T>
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:92

Properties

data

data: T

The data object. Read-only.

`Private` draftData

draftData: T

`Private` eventEmitter

eventEmitter: default<ImmerChangeset<T>, T> = ...

`Private` innerErrors

innerErrors: Record<string, ValidationError> = {}

`Private` inversePatches

inversePatches: Patch[] = []

`Private` patches

patches: Patch[] = []

Accessors

changes

get changes(): Change[]
Returns an array of the last changes made to the data object.

Returns Change[]
Implementation of Changeset.changes
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:53

errors

get errors(): ValidationError[]
Returns an array of the errors associated with the changeset.

Returns ValidationError[]
Implementation of Changeset.errors
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:60

isDirty

get isDirty(): boolean
Returns a boolean indicating whether the changeset is dirty (has changes).

Returns boolean
Implementation of Changeset.isDirty
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:88

isInvalid

get isInvalid(): boolean
Returns a boolean indicating whether the changeset is invalid (has errors).

Returns boolean
Implementation of Changeset.isInvalid
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:81

isPristine

get isPristine(): boolean
Returns a boolean indicating whether the changeset is pristine (has no changes).

Returns boolean
Implementation of Changeset.isPristine
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:74

isValid

get isValid(): boolean
Returns a boolean indicating whether the changeset is valid (has no errors).

Returns boolean
Implementation of Changeset.isValid
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:67

Methods

addError

addError(error): void
Adds a new error object to the changeset.
Parameters
- error: ValidationError
  The error object to add.
Returns void
Implementation of Changeset.addError
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:138

execute

execute(): void
Applies the accumulated changes to the data object.

Returns void
Implementation of Changeset.execute
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:100

get

get<K>(key): Get<T, K>
Returns the value of the specified key from the draft object.
Type Parameters
- K extends string
Parameters
- key: K
  The name of the property to get.
Returns Get<T, K>
The value of the property.
Implementation of Changeset.get
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:163

`Private` normalizedPatches

normalizedPatches(): {
key: string;
value: any;
}[]
Returns {
key: string;
value: any;
}[]
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:206

onSet

onSet(fn): (() => void)
Registers a callback function to be called whenever a property is set using the set method.
Parameters
- fn: OnSetCallback<ImmerChangeset<T>, T>
  The callback function to register.
Returns (() => void)
A function that can be called to unregister the callback.
- - (): void
  - Returns void
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:199

removeError

removeError(key): void
Removes the error with the specified key from the changeset.
Parameters
- key: string
  The key of the error to remove.
Returns void
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:146

removeErrors

removeErrors(): void
Removes all errors from the changeset.

Returns void
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:154

`Private` resetPatches

resetPatches(): void
Returns void
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:213

rollback

rollback(): void
Reverts the changes made to the draft.

Returns void
Implementation of Changeset.rollback
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:122

rollbackProperty

rollbackProperty(property): void
Reverts the changes made to the specified property of the changeset object.
Parameters
- property: string
  The name of the property to revert.
Returns void
Implementation of Changeset.rollbackProperty
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:130

save

save(): Promisable<void>
Applies the accumulated changes to the data object and sets the changeset in a pristine state. No rollback is possible after this.

Returns Promisable<void>
Implementation of Changeset.save
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:114

set

set<K>(key, value): void
Sets the value of the specified key to the given value in the draft object.
Type Parameters
- K extends string
Parameters
- key: K
  The name of the property to set.
- value: Get<T, K>
  The value to set the property to.
Returns void
Implementation of Changeset.set
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:172

unexecute

unexecute(): void
Reverts the previously applied changes to the data object.

Returns void
Implementation of Changeset.unexecute
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:107

validate

validate(validation): Promise<void>
Runs the specified validation function on the draft object.
Parameters
- validation: ValidationFunction<T>
  The validation function to run.
Returns Promise<void>
Implementation of Changeset.validate
- Defined in ember-immer-changeset/src/changeset/immer-changeset.ts:190

Class ImmerChangeset<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ImmerChangeset<T>

Properties

data

Private draftData

Private eventEmitter

Private innerErrors

Private inversePatches

Private patches

Accessors

changes

Returns Change[]

errors

Returns ValidationError[]

isDirty

Returns boolean

isInvalid

Returns boolean

isPristine

Returns boolean

isValid

Returns boolean

Methods

addError

Parameters

Returns void

execute

Returns void

get

Type Parameters

Parameters

Returns Get<T, K>

Private normalizedPatches

Returns { key: string; value: any; }[]

onSet

Parameters

Returns (() => void)

Returns void

removeError

Parameters

Returns void

removeErrors

Returns void

Private resetPatches

Returns void

rollback

Returns void

rollbackProperty

Parameters

Returns void

save

Returns Promisable<void>

set

Type Parameters

Parameters

Returns void

unexecute

Returns void

validate

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Private` draftData

`Private` eventEmitter

`Private` innerErrors

`Private` inversePatches

`Private` patches

`Private` normalizedPatches

Returns {
key: string;
value: any;
}[]

`Private` resetPatches