Interface ReplaceOneModel<TSchema>

interface ReplaceOneModel<TSchema> {
    collation?: CollationOptions;
    filter: Filter<TSchema>;
    hint?: Hint;
    replacement: WithoutId<TSchema>;
    upsert?: boolean;
}

Type Parameters

TSchema extends Document = Document

Index

Properties

collation? filter hint? replacement upsert?

Properties

`Optional`collation

collation?: CollationOptions

Specifies a collation.

filter

filter: Filter<TSchema>

The filter to limit the replaced document.

`Optional`hint

hint?: Hint

The index to use. If specified, then the query system will only consider plans using the hinted index.

replacement

replacement: WithoutId<TSchema>

The document with which to replace the matched document.

`Optional`upsert

upsert?: boolean

When true, creates a new document if no document matches the query.