Interface UpdateOneModel<TSchema>

interface UpdateOneModel<TSchema> {
    arrayFilters?: mongoose.mongo.BSON.Document[];
    collation?: CollationOptions;
    filter: mongoose.mongo.Filter<TSchema>;
    hint?: Hint;
    update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[];
    upsert?: boolean;
}

Type Parameters

TSchema extends mongoose.mongo.BSON.Document = mongoose.mongo.BSON.Document

Index

Properties

arrayFilters? collation? filter hint? update upsert?

Properties

`Optional` arrayFilters

arrayFilters?: mongoose.mongo.BSON.Document[]

A set of filters specifying to which array elements an update should apply.

`Optional` collation

collation?: CollationOptions

Specifies a collation.

filter

filter: mongoose.mongo.Filter<TSchema>

The filter to limit the updated documents.

`Optional` hint

hint?: Hint

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

update

update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[]

A document or pipeline containing update operators.

`Optional` upsert

upsert?: boolean

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