Interface GenericFindOneAndReplaceOptions

Specifies which fields should be included/excluded in the returned documents.

If not specified, all fields are included.

When specifying a projection, it's the user's responsibility to handle the return type carefully, as the projection will, of course, affect the shape of the returned documents. It may be a good idea to cast the returned documents into a type that reflects the projection to avoid runtime errors.

Example

interface User {
  name: string;
  age: number;
}

const collection = db.collection<User>('users');

const doc = await collection.findOne({}, {
  projection: {
    _id: 0,
    name: 1,
  },
  vector: [.12, .52, .32],
  includeSimilarity: true,
}) as { name: string, $similarity: number };

// Ok
console.log(doc.name);
console.log(doc.$similarity);

// Causes type error
console.log(doc._id);
console.log(doc.age);
Copy

Specifies whether to return the document before or after the update.

Set to before to return the document before the update to see the original state of the document.

Set to after to return the document after the update to see the updated state of the document immediately.

Defaults to 'before'.

Default Value

'before'
Copy

The order in which to apply the update if the filter selects multiple documents.

If multiple documents match the filter, only one will be updated.

Defaults to null, where the order is not guaranteed.

Default Value

null
Copy

If true, perform an insert if no documents match the filter.

If false, do not insert if no documents match the filter.

Defaults to false.

Default Value

false
Copy

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

• Use sort: { $vector: [...] } instead.

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

• Use sort: { $vectorize: '...' } instead.