diff --git a/.gitignore b/.gitignore index 9610afd15bc..636851962a2 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,7 @@ etc/docs/template/.hugo_build.lock types docs/gen +!docs/**/types # Directory for instrumented libs generated by jscoverage/JSCover lib-cov diff --git a/docs/5.7/types/AbstractCursorEvents.html b/docs/5.7/types/AbstractCursorEvents.html new file mode 100644 index 00000000000..83d5fa34326 --- /dev/null +++ b/docs/5.7/types/AbstractCursorEvents.html @@ -0,0 +1,421 @@ +
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
legacy?: booleanOutput using the Extended JSON v1 spec
+false
Optional
relaxed?: booleanEnable Extended JSON's relaxed
mode, which attempts to return native JS types where possible, rather than BSON types
false
Optional
useEnable native bigint support
+false
Generated using TypeDoc
Optional
high: number | booleanOptional
unsigned: booleanGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
MongoDB Driver style callback
+Optional
error: AnyErrorOptional
result: TGenerated using TypeDoc
Generated using TypeDoc
Optional
response: anyGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions
+Generated using TypeDoc
Generated using TypeDoc
Event description type
+Generated using TypeDoc
Generated using TypeDoc
For backwards compatibility, true is interpreted as "allPlansExecution" +and false as "queryPlanner". Prior to server version 3.6, aggregate() +ignores the verbosity parameter and executes in "queryPlanner".
+Generated using TypeDoc
A MongoDB filter can be some portion of the schema or a set of operators
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Rest
...args: any[]Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Given an object shaped type, return the type of the _id field or default to ObjectId
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
error: MongoErrorGenerated using TypeDoc
returns tuple of strings (keys to be joined on '.') that represent every path into a schema +https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/
+Through testing we determined that a depth of 8 is safe for the typescript compiler +and provides reasonable compilation times. This number is otherwise not special and +should be changed if issues are found with this level of checking. Beyond this +depth any helpers that make use of NestedPaths should devolve to not asserting any +type safety on the input.
+Generated using TypeDoc
returns keys (strings) for every path into a schema with a value of type +https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/
+Generated using TypeDoc
A type that extends Document but forbids anything that "looks like" an object id.
+Generated using TypeDoc
It avoids using fields with not acceptable types
+Generated using TypeDoc
Generated using TypeDoc
Experimental
+Generated using TypeDoc
Experimental
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents a specific point in time on a server. Can be retrieved by using db.command()
Generated using TypeDoc
Add an optional _id field to an object shaped type
+Optional
_id?: InferIdType<TSchema>Generated using TypeDoc
Adds an optional _id field to an object shaped type, unless the _id field is required on that type. +In the case _id is required, this method continues to require_id.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.
+Generated using TypeDoc
Generated using TypeDoc
Optional
authdb?: anyThis is an internal option that has undefined behavior for this API
+Optional
collation?: anyThis is an internal option that has undefined behavior for this API
+Optional
comment?: anyThis is an internal option that has undefined behavior for this API
+Optional
dbThis is an internal option that has undefined behavior for this API
+Optional
explain?: anyThis is an internal option that has undefined behavior for this API
+Optional
maxThis is an internal option that has undefined behavior for this API
+Optional
noThis is an internal option that has undefined behavior for this API
+Optional
omitThis is an internal option that has undefined behavior for this API
+Optional
readThis is an internal option that has undefined behavior for this API
+Optional
readThe read preference
+Optional
retryThis is an internal option that has undefined behavior for this API
+Optional
session?: ClientSessionSpecify ClientSession for this command
+Optional
willThis is an internal option that has undefined behavior for this API
+Optional
writeThis is an internal option that has undefined behavior for this API
+Generated using TypeDoc
Optional
readOptional
session?: ClientSessionGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Experimental
Generated using TypeDoc
Experimental
Generated using TypeDoc
Experimental
Optional
$addOptional
$bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, { Optional
$currentOptional
$inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>Optional
$max?: StrictMatchKeysAndValues<TSchema>Optional
$min?: StrictMatchKeysAndValues<TSchema>Optional
$mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>Optional
$pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>Optional
$pull?: PullOperator<TSchema>Optional
$pullOptional
$push?: PushOperator<TSchema>Optional
$rename?: Record<string, string>Optional
$set?: StrictMatchKeysAndValues<TSchema>Optional
$setOptional
$unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
$addOptional
$bit?: OnlyFieldsOfType<TSchema, NumericType | undefined, { Optional
$currentOptional
$inc?: OnlyFieldsOfType<TSchema, NumericType | undefined>Optional
$max?: MatchKeysAndValues<TSchema>Optional
$min?: MatchKeysAndValues<TSchema>Optional
$mul?: OnlyFieldsOfType<TSchema, NumericType | undefined>Optional
$pop?: OnlyFieldsOfType<TSchema, ReadonlyArray<any>, 1 | -1>Optional
$pull?: PullOperator<TSchema>Optional
$pullOptional
$push?: PushOperator<TSchema>Optional
$rename?: Record<string, string>Optional
$set?: MatchKeysAndValues<TSchema>Optional
$setOptional
$unset?: OnlyFieldsOfType<TSchema, any, "" | true | 1>Generated using TypeDoc
Generated using TypeDoc
Add an _id field to an object shaped type
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Remove the _id field from an object shaped type
+Generated using TypeDoc
Static
Readonly
captureStatic
captureSets or gets the default captureRejection value for all emitters.
+Value: boolean
+Change the default captureRejections
option on all new EventEmitter
objects.
v13.4.0, v12.16.0
+Inherited from TypedEventEmitter.captureRejections
Static
defaultBy default, a maximum of 10
listeners can be registered for any single
+event. This limit can be changed for individual EventEmitter
instances
+using the emitter.setMaxListeners(n)
method. To change the default
+for allEventEmitter
instances, the events.defaultMaxListeners
property can be used. If this value is not a positive number, a RangeError
is thrown.
Take caution when setting the events.defaultMaxListeners
because the
+change affects allEventEmitter
instances, including those created before
+the change is made. However, calling emitter.setMaxListeners(n)
still has
+precedence over events.defaultMaxListeners
.
This is not a hard limit. The EventEmitter
instance will allow
+more listeners to be added but will output a trace warning to stderr indicating
+that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter
, the emitter.getMaxListeners()
and emitter.setMaxListeners()
methods can be used to
+temporarily avoid this warning:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
+
+The --trace-warnings
command-line flag can be used to display the
+stack trace for such warnings.
The emitted warning can be inspected with process.on('warning')
and will
+have the additional emitter
, type
, and count
properties, referring to
+the event emitter instance, the event's name and the number of attached
+listeners, respectively.
+Its name
property is set to 'MaxListenersExceededWarning'
.
v0.11.2
+Inherited from TypedEventEmitter.defaultMaxListeners
Static
Readonly
errorThis symbol shall be used to install a listener for only monitoring 'error'
-events. Listeners installed using this symbol are called before the regular
-'error'
listeners are called.
Installing a listener using this symbol does not change the behavior once an
-'error'
event is emitted, therefore the process will still crash if no
+
This symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular'error'
listeners are called.
Installing a listener using this symbol does not change the behavior once an'error'
event is emitted. Therefore, the process will still crash if no
regular 'error'
listener is installed.
v13.6.0, v12.17.0
+Inherited from TypedEventEmitter.errorMonitor
v15.2.0, v14.17.0
Inherited from TypedEventEmitter.getEventListeners
Static
getReturns the currently set max amount of listeners.
+For EventEmitter
s this behaves exactly the same as calling .getMaxListeners
on
+the emitter.
For EventTarget
s this is the only way to get the max event listeners for the
+event target. If the number of event handlers on a single EventTarget exceeds
+the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
+
+v19.9.0
+Inherited from TypedEventEmitter.getMaxListeners
+Static
listenerv15.4.0
Inherited from TypedEventEmitter.setMaxListeners
It is possible to search using alternative types in mongodb e.g. +string types can be searched using a regex in mongo +array types can be searched using their element type
+