DataEditModule

PackageReified.Data

Summary

NameSignatureSynopsis
setDataEdit.set path valueDescribes replacing a value, or adding a missing final object field.
replaceDataEdit.replace path valueDescribes replacing an existing value.
removeDataEdit.remove pathDescribes removing an existing field or list item.
appendDataEdit.append path valueDescribes appending an item to an existing list.
prependDataEdit.prepend path valueDescribes prepending an item to an existing list.
insertDataEdit.insert path index valueDescribes inserting an item at a valid list index.
renameDataEdit.rename path nameDescribes renaming an existing object field without moving it.
updateDataEdit.update path changeDescribes applying a function to an existing value.

set

DataEdit.set path value
Member
Describes replacing a value, or adding a missing final object field.

Parameters

NameTypeDescription
pathstring
value^a

Returns

DataEdit

Verification Examples

DataEdit.set "plan" "pro" // one DataEdit

replace

DataEdit.replace path value
Member
Describes replacing an existing value.

Parameters

NameTypeDescription
pathstring
value^a

Returns

DataEdit

Verification Examples

DataEdit.replace "name" "Grace" // one DataEdit

remove

DataEdit.remove path
Member
Describes removing an existing field or list item.

Parameters

NameTypeDescription
pathstring

Returns

DataEdit

Verification Examples

DataEdit.remove "obsolete" // one DataEdit

append

DataEdit.append path value
Member
Describes appending an item to an existing list.

Parameters

NameTypeDescription
pathstring
value^a

Returns

DataEdit

Verification Examples

DataEdit.append "roles" "admin" // one DataEdit

prepend

DataEdit.prepend path value
Member
Describes prepending an item to an existing list.

Parameters

NameTypeDescription
pathstring
value^a

Returns

DataEdit

Verification Examples

DataEdit.prepend "roles" "admin" // one DataEdit

insert

DataEdit.insert path index value
Member
Describes inserting an item at a valid list index.

Parameters

NameTypeDescription
pathstring
indexint
value^a

Returns

DataEdit

Verification Examples

DataEdit.insert "roles" 1 "admin" // one DataEdit

rename

DataEdit.rename path name
Member
Describes renaming an existing object field without moving it.

Parameters

NameTypeDescription
pathstring
namestring

Returns

DataEdit

Verification Examples

DataEdit.rename "name" "displayName" // one DataEdit

update

DataEdit.update path change
Member
Describes applying a function to an existing value.

Parameters

NameTypeDescription
pathstring
changeData -> Data

Returns

DataEdit

Verification Examples

DataEdit.update "active" (fun _ -> Data.Bool false) // one DataEdit