Type alias OperationUpdates

OperationUpdates: {
    $addToSet?: AppendDeleteSetChange[];
    $addValue?: AddValueChange[];
    $deleteFromSet?: AppendDeleteSetChange[];
    $remove?: RemoveChange[];
    $set?: SetChange[];
}

A set of changes to perform in an [[updateById]] or [[updateChildById]] operation as an object. Each property is optional, but at least one change must be specified.

Type declaration

  • Optional $addToSet?: AppendDeleteSetChange[]

    A set of key path + value pairs for which set properties are to be appended.

    Key paths are specified in string (e.g. profile.roles) or array (e.g. `['profile', 'roles']) form.

  • Optional $addValue?: AddValueChange[]

    A set of key path + value pairs for which number properties are to be added to.

    Key paths are specified in string (e.g. profile.count) or array (e.g. `['profile', 'count']) form.

  • Optional $deleteFromSet?: AppendDeleteSetChange[]

    A set of key path + value pairs for which set properties are to be appended.

    Key paths are specified in string (e.g. profile.roles) or array (e.g. `['profile', 'roles']) form.

  • Optional $remove?: RemoveChange[]

    The list of key paths to clear the value. Key paths may be specified in string form e.g. 'profile.name' or array form e.g. ['profile', 'name']

  • Optional $set?: SetChange[]

    The list of key paths to set a value. This is a list of tuples, in the form [key_path, new_value]. The key paths can be specified in a string form e.g. 'profile.name' or array form e.g. ['profile', 'name']

Settings

Member Visibility

Theme

Generated using TypeDoc