Type Definitions
EditFieldOption
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string | number | The affected element |
|
field |
string | The field to edit |
|
operation |
"set" | "remove" | "append" | "increment" | "decrement" | "array-push" | "array-delete" | "array-splice" | Operation for the field |
|
value |
string | number | boolean | Array |
<optional> |
The value to write |
Type:
- Object
SearchOption
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
field |
string | The field to be searched for |
|
criteria |
"!=" | "==" | ">=" | "<=" | "<" | ">" | "in" | "includes" | "startsWith" | "endsWith" | "array-contains" | "array-contains-none" | "array-contains-any" | "array-length-(eq|df|gt|lt|ge|le)" | Search criteria to filter results |
|
value |
string | number | boolean | Array | The value to be searched for |
|
ignoreCase |
boolean |
<optional> |
Is it case sensitive? (default true) |
Type:
- Object
SelectOption
Properties:
| Name | Type | Description |
|---|---|---|
fields |
Array.<string> | Selected fields to be returned |
Type:
- Object
ValueOption
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
field |
string | Field to search |
|
flatten |
boolean |
<optional> |
Flatten array fields? (default false) |
Type:
- Object
WriteConfirmation
Properties:
| Name | Type | Description |
|---|---|---|
message |
string | Write status |
Type:
- Object