chore: document method

Author: Julusian

meteor/server/collections/collection.ts

@@ -1,4 +1,4 @@
-import { FindOptions, MongoModifier, MongoQuery } from '@sofie-automation/corelib/dist/mongo'
+import { FindOptions, MongoModifier, MongoQuery, ObserveChangesOptions } from '@sofie-automation/corelib/dist/mongo'
 import { ProtectedString } from '@sofie-automation/corelib/dist/protectedString'
 import { Meteor } from 'meteor/meteor'
 import { Mongo } from 'meteor/mongo'
@@ -235,7 +235,7 @@ export interface AsyncOnlyReadOnlyMongoCollection<DBInterface extends { _id: Pro
 		selector: MongoQuery<DBInterface> | DBInterface['_id'],
 		callbacks: PromisifyCallbacks<ObserveChangesCallbacks<DBInterface>>,
 		findOptions?: Omit<FindOptions<DBInterface>, 'fields'>,
-		callbackOptions?: { nonMutatingCallbacks?: boolean | undefined }
+		callbackOptions?: ObserveChangesOptions
 	): Promise<Meteor.LiveQueryHandle>
 
 	/**

meteor/server/collections/implementations/asyncCollection.ts

@@ -1,4 +1,4 @@
-import { MongoModifier, MongoQuery } from '@sofie-automation/corelib/dist/mongo'
+import { MongoModifier, MongoQuery, ObserveChangesOptions } from '@sofie-automation/corelib/dist/mongo'
 import { ProtectedString, protectString, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
 import { Meteor } from 'meteor/meteor'
 import { Mongo } from 'meteor/mongo'
@@ -142,7 +142,7 @@ export class WrappedAsyncMongoCollection<DBInterface extends { _id: ProtectedStr
 		selector: MongoQuery<DBInterface> | DBInterface['_id'],
 		callbacks: PromisifyCallbacks<ObserveChangesCallbacks<DBInterface>>,
 		findOptions?: FindOptions<DBInterface>,
-		callbackOptions?: { nonMutatingCallbacks?: boolean | undefined }
+		callbackOptions?: ObserveChangesOptions
 	): Promise<Meteor.LiveQueryHandle> {
 		const span = profiler.startSpan(`MongoCollection.${this.name}.observeChanges`)
 		if (span) {

packages/corelib/src/mongo.ts

@@ -44,6 +44,15 @@ export interface FindOneOptions<TDoc> {
 export interface FindOptions<TDoc> extends FindOneOptions<TDoc> {
 	limit?: number
 }
+
+export interface ObserveChangesOptions {
+	/**
+	 * If your observer functions do not mutate the passed arguments, you can set this to true, which
+	 * improves performance by reducing the amount of data copies.
+	 */
+	nonMutatingCallbacks?: boolean | undefined
+}
+
 /**
  * Subset of MongoSelector, only allows direct queries, not QueryWithModifiers such as $explain etc.
  * Used for simplified expressions (ie not using $and, $or etc..)