replace() #
Replaces the content of a document.
Arguments #
replace(document: JSONObject, options?: JSONObject): Promise<JSONObject>;| Arguments | Type | Description |
|---|---|---|
document | JSONObject | The document to create. The provided object must contain a _id property, which is the document unique identifier |
options | JSONObject | Optional arguments |
options #
The options argument accepts the following parameters:
| Options | Type | Description |
|---|---|---|
refresh | string | If set with the wait_for string value, then the function will respond only after the document has been indexed |
Return #
The replace function returns a promise, resolving to the document replacement result.
Example #
const content = {
_id: '<unique id>',
someField: 'some content',
anotherField: 'another content'
};
const result = await repository.replace(content);
/*
* { _index: '%<plugin name>',
* _type: '<collection>',
* _id: '<a unique id>',
* _version: 3,
* _shards: { total: 2, successful: 1, failed: 0 },
* created: false,
* _source: {
* someField: 'some content',
* anotherField: 'another content'
* }
* }
*/Edit this page on Github(opens new window)