Preparing search index...
The search index is not available
biorate
biorate
mongodb
mongoose
PipelineStage
Sample
Interface Sample
Hierarchy
Sample
Index
Properties
$sample
Properties
$sample
$sample
:
{
size
:
number
;
}
$sample
reference
Type declaration
size
:
number
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
$sample
biorate
amf
amqp
async-
loop
axios
axios-
prometheus
batcher
bit-
array
clickhouse
collection
config
config-
loader
config-
loader-
env
config-
loader-
fs
config-
loader-
vault
connector
errors
file-
config
haproxy
i18n
inversion
ioredis
kafkajs
lifecycled
migrations
minio
mocha
mocha-
spec
mongodb
Abstract
Cursor
Abstract
Cursor
Events
Abstract
Cursor
Options
Accepted
Fields
Add
To
Set
Operators
Add
User
Options
Admin
Aggregate
Options
Aggregation
Cursor
Aggregation
Cursor
Options
Alternative
Type
Any
Bulk
Write
Operation
Any
Error
Array
Element
Array
Operator
Auth
Auth
Mechanism
Auth
Mechanism
Properties
Auto
Encrypter
Auto
Encryption
Logger
Level
Auto
Encryption
Options
Auto
Encryption
Tls
Options
BSON
BSONReg
Exp
BSONSerialize
Options
BSONSymbol
BSONType
BSONType
Alias
Batch
Batch
Type
Binary
Bitwise
Filter
Bulk
Operation
Base
Bulk
Write
Operation
Error
Bulk
Write
Options
Bulk
Write
Result
CURSOR_
FLAGS
Callback
Cancellation
Token
Change
Stream
Change
Stream
Coll
Mod
Document
Change
Stream
Create
Document
Change
Stream
Create
Index
Document
Change
Stream
Delete
Document
Change
Stream
Document
Change
Stream
Document
CollectionUUID
Change
Stream
Document
Common
Change
Stream
Document
Key
Change
Stream
Document
Operation
Description
Change
Stream
Drop
Database
Document
Change
Stream
Drop
Document
Change
Stream
Drop
Index
Document
Change
Stream
Events
Change
Stream
Insert
Document
Change
Stream
Invalidate
Document
Change
Stream
Name
Space
Change
Stream
Options
Change
Stream
Refine
Collection
Shard
Key
Document
Change
Stream
Rename
Document
Change
Stream
Replace
Document
Change
Stream
Reshard
Collection
Document
Change
Stream
Shard
Collection
Document
Change
Stream
Split
Event
Change
Stream
Update
Document
Client
Metadata
Client
Metadata
Options
Client
Session
Client
Session
Events
Client
Session
Options
Close
Options
Cluster
Time
Clustered
Collection
Options
Code
Coll
Stats
Coll
Stats
Options
Collation
Options
Collection
Collection
Info
Collection
Options
Command
Failed
Event
Command
Operation
Options
Command
Started
Event
Command
Succeeded
Event
Common
Events
Compressor
Compressor
Name
Condition
Connect
Options
Connection
Check
Out
Failed
Event
Connection
Check
Out
Started
Event
Connection
Checked
In
Event
Connection
Checked
Out
Event
Connection
Closed
Event
Connection
Created
Event
Connection
Events
Connection
Options
Connection
Pool
Cleared
Event
Connection
Pool
Closed
Event
Connection
Pool
Created
Event
Connection
Pool
Events
Connection
Pool
Monitoring
Event
Connection
Pool
Options
Connection
Pool
Ready
Event
Connection
Ready
Event
Count
Documents
Options
Count
Options
Create
Collection
Options
Create
Indexes
Options
Cursor
Flag
Cursor
Stream
Options
DBRef
Db
Db
Options
Db
Stats
Options
Decimal128
Delete
Many
Model
Delete
One
Model
Delete
Options
Delete
Result
Delete
Statement
Distinct
Options
Document
Double
Driver
Info
Drop
Collection
Options
Drop
Database
Options
Drop
Indexes
Options
End
Session
Options
Enhanced
Omit
Error
Description
Estimated
Document
Count
Options
Eval
Options
Event
Emitter
With
State
Events
Description
Explain
Options
Explain
Verbosity
Explain
Verbosity
Like
Filter
Filter
Operations
Filter
Operators
Find
Cursor
Find
One
And
Delete
Options
Find
One
And
Replace
Options
Find
One
And
Update
Options
Find
Operators
Find
Options
Flatten
GSSAPICanonicalization
Value
Generic
Listener
GridFSBucket
GridFSBucket
Events
GridFSBucket
Options
GridFSBucket
Read
Stream
GridFSBucket
Read
Stream
Options
GridFSBucket
Read
Stream
Options
With
Revision
GridFSBucket
Write
Stream
GridFSBucket
Write
Stream
Options
GridFSChunk
GridFSFile
Hedge
Options
Hint
Host
Address
IdPServer
Info
IdPServer
Response
Index
Index
Description
Index
Direction
Index
Information
Options
Index
Specification
Infer
Id
Type
Insert
Many
Result
Insert
One
Model
Insert
One
Options
Insert
One
Result
Int32
Integer
Type
Is
Any
Join
Keys
OfAType
Keys
Of
Other
Type
LEGAL_
TCP_
SOCKET_
OPTIONS
LEGAL_
TLS_
SOCKET_
OPTIONS
List
Collections
Cursor
List
Collections
Options
List
Databases
Options
List
Databases
Result
List
Indexes
Cursor
List
Indexes
Options
List
Search
Indexes
Cursor
List
Search
Indexes
Options
Long
MONGO_
CLIENT_
EVENTS
Match
Keys
And
Values
Max
Key
Min
Key
Model
Options
Modify
Result
MongoAPIError
MongoAWSError
Mongo
Azure
Error
Mongo
Batch
Re
Execution
Error
Mongo
Bulk
Write
Error
Mongo
Change
Stream
Error
Mongo
Client
Mongo
Client
Events
Mongo
Client
Options
Mongo
Compatibility
Error
Mongo
Credentials
Mongo
Credentials
Options
Mongo
Cursor
Exhausted
Error
Mongo
Cursor
In
Use
Error
MongoDBCollection
Namespace
MongoDBNamespace
Mongo
Decompression
Error
Mongo
Driver
Error
Mongo
Error
Mongo
Error
Label
Mongo
Expired
Session
Error
Mongo
GridFSChunk
Error
Mongo
GridFSStream
Error
Mongo
Invalid
Argument
Error
Mongo
Kerberos
Error
Mongo
Missing
Credentials
Error
Mongo
Missing
Dependency
Error
Mongo
Network
Error
Mongo
Network
Error
Options
Mongo
Network
Timeout
Error
Mongo
Not
Connected
Error
Mongo
Options
Mongo
Parse
Error
Mongo
Runtime
Error
Mongo
Server
Closed
Error
Mongo
Server
Error
Mongo
Server
Selection
Error
Mongo
System
Error
Mongo
Tailable
Cursor
Error
Mongo
Topology
Closed
Error
Mongo
Transaction
Error
Mongo
Unexpected
Server
Response
Error
Mongo
Write
Concern
Error
Monitor
Events
Monitor
Options
Nested
Paths
Nested
Paths
Of
Type
Non
Object
Id
Like
Document
Not
Accepted
Fields
Numeric
Type
OIDCCallback
Context
OIDCRefresh
Function
OIDCRequest
Function
Object
Id
One
Or
More
Only
Fields
Of
Type
Operation
Options
Operation
Time
Optional
Id
Optional
Unless
Required
Id
Ordered
Bulk
Operation
Pk
Factory
Plugins
Profiling
Level
Profiling
Level
Options
Prop
Property
Type
Proxy
Options
Pull
All
Operator
Pull
Operator
Push
Operator
Query
Method
Read
Concern
Read
Concern
Level
Read
Concern
Like
Read
Preference
Read
Preference
From
Options
Read
Preference
Like
Read
Preference
Like
Options
Read
Preference
Mode
Read
Preference
Options
Reg
Exp
Or
String
Remove
User
Options
Rename
Options
Replace
One
Model
Replace
Options
Resume
Options
Resume
Token
Return
Document
Role
Specification
Root
Filter
Operators
Run
Command
Cursor
Run
Command
Options
Run
Cursor
Command
Options
Schema
Member
Search
Index
Description
Select
Server
Options
Server
Api
Server
Api
Version
Server
Capabilities
Server
Closed
Event
Server
Description
Server
Description
Changed
Event
Server
Events
Server
Heartbeat
Failed
Event
Server
Heartbeat
Started
Event
Server
Heartbeat
Succeeded
Event
Server
Opening
Event
Server
Session
Server
Session
Id
Server
Type
Set
Fields
Set
Profiling
Level
Options
Sort
Sort
Direction
Stream
Stream
Description
Stream
Description
Options
Strict
Filter
Strict
Match
Keys
And
Values
Strict
Update
Filter
Supported
Node
Connection
Options
Supported
Socket
Options
SupportedTLSConnection
Options
SupportedTLSSocket
Options
Tag
Set
Time
Series
Collection
Options
Timestamp
Topology
Closed
Event
Topology
Description
Topology
Description
Changed
Event
Topology
Description
Options
Topology
Events
Topology
Opening
Event
Topology
Type
Topology
Version
Transaction
Transaction
Options
Typed
Event
Emitter
Unordered
Bulk
Operation
Update
Description
Update
Filter
Update
Many
Model
Update
One
Model
Update
Options
Update
Result
Update
Statement
Validate
Collection
Options
W
Wired
Tiger
Data
With
Id
With
Session
Callback
With
Transaction
Callback
Without
Id
Write
Concern
Write
Concern
Error
Write
Concern
Error
Data
Write
Concern
Options
Write
Concern
Settings
Write
Error
deserialize
serialize
default
Classes
errors
mongoose
default
Error
Expression
Pipeline
Stage
Add
Fields
Bucket
Bucket
Auto
Coll
Stats
Count
Densify
Facet
Fill
Geo
Near
Graph
Lookup
Group
Index
Stats
Limit
List
Sessions
Lookup
Match
Merge
Out
Plan
Cache
Stats
Project
Redact
Replace
Root
Replace
With
Sample
Search
Search
Meta
Set
Set
Window
Fields
Skip
Sort
Sort
By
Count
Union
With
Unset
Unwind
Facet
Pipeline
Stage
Schema
Types
mongo
Connection
States
Aggregate
Connection
Cursor
Document
Error
Mongoose
Error
Native
Buffer
Query
Schema
Schema
Type
Schema
Type
Options
Virtual
Type
mquery
Accepts
Discriminator
Aggregate
Options
Any
Object
Async
Validate
Fn
Collection
Collection
Base
Connect
Options
Create
Options
Default
Schema
Options
Discriminator
Options
Document
Set
Options
Each
Async
Options
Geo
Search
Options
Index
Manager
Index
Options
Indexes
Diff
Insert
Many
Options
Legacy
Async
Validate
Fn
Map
Reduce
Options
Mixed
Schema
Type
Options
Model
Models
Modify
Result
Mongoose
Bulk
Write
Options
Mongoose
Options
Populate
Option
Populate
Options
Query
Options
Query
Timestamps
Config
Remove
Options
Save
Options
Schema
Options
Schema
Timestamps
Config
Session
Operation
Session
Option
Session
Starter
Sync
Indexes
Options
Tag
Set
To
Object
Options
Validate
Fn
Validate
Opts
Validator
Validator
Message
Fn
Validator
Props
Virtual
Type
Options
Accumulator
Operator
Aggregate
Extract
Aggregation
Variables
Any
Array
Any
Expression
Any
Keys
Apply
Basic
Query
Casting
Apply
Schema
Options
Arithmetic
Expression
Operator
Array
Expression
Array
Expression
Operator
Array
Expression
Operator
Returning
Any
Array
Expression
Operator
Returning
Array
Array
Expression
Operator
Returning
Boolean
Array
Expression
Operator
Returning
Number
Array
Expression
Operator
Returning
Object
Binary
Expression
Boolean
Expression
Boolean
Expression
Operator
Boolean
Schema
Definition
Callback
Callback
Error
Callback
Without
Result
Callback
Without
Result
And
Optional
Error
Cast
Error
Client
Session
Client
Session
Options
Code
Expression
Comparison
Expression
Operator
Comparison
Expression
Operator
Returning
Boolean
Comparison
Expression
Operator
Returning
Number
Compile
Model
Options
Condition
Conditional
Expression
Operator
Connection
Sync
Indexes
Result
Cursor
Flag
Custom
Aggregation
Expression
Operator
Custom
Aggregation
Expression
Operator
Returning
Any
Data
Size
Operator
Data
Size
Operator
Returning
Number
Date
Date
Expression
Date
Expression
Operator
Date
Expression
Operator
Returning
Date
Date
Expression
Operator
Returning
Number
Date
Expression
Operator
Returning
Object
Date
Expression
Operator
Returning
String
Date
Schema
Definition
Date
Unit
Decimal128
Default
Type
Default
Type
Key
Discriminator
Model
Discriminator
Schema
Error
Handling
Middleware
Function
Error
Handling
Middleware
With
Option
Expression
Extract
Mongoose
Array
Filter
Query
Flat
Record
Flatten
Maps
Format
String
Function
Expression
Get
Lean
Result
Type
Hydrated
Array
Subdocument
Hydrated
Document
Hydrated
Document
From
Schema
Hydrated
Single
Subdocument
If
Any
If
Equals
If
Unknown
Index
Definition
Index
Direction
Infer
Id
Infer
Schema
Type
Insert
Many
Result
Is
It
Record
And
Not
Any
Literal
Expression
Operator
Literal
Expression
Operator
Returning
Any
Literal
Expression
Returning
Any
Merge
Type
Middleware
Options
Miscellaneous
Expression
Operator
Miscellaneous
Expression
Operator
Returning
Number
Mixed
Mongoose
Mongoose
Default
Query
Middleware
Mongoose
Distinct
Document
Middleware
Mongoose
Distinct
Query
Middleware
Mongoose
Document
Middleware
Mongoose
Query
And
Document
Middleware
Mongoose
Query
Middleware
Mongoose
Query
Options
Mongoose
Query
Or
Document
Middleware
Mongoose
Raw
Result
Query
Middleware
Null
Expression
Number
Number
Expression
Number
Schema
Definition
Object
Expression
Object
Expression
Operator
Object
Expression
Operator
Returning
Array
Object
Expression
Operator
Returning
Object
Object
Id
Object
Id
Expression
Object
Id
Schema
Definition
Obtain
Document
Type
Obtain
Schema
Generic
One
Collection
Sync
Indexes
Result
Path
Paths
To
Validate
Pipeline
Stage
Populated
Doc
Post
Middleware
Function
Pre
Middleware
Function
Pre
Save
Middleware
Function
Projection
Element
Type
Projection
Fields
Projection
Type
Query
Op
That
Returns
Document
Query
Selector
Query
With
Helpers
Ref
Type
Regex
Options
Require_
id
Resolve
Schema
Options
Resolve
Timestamps
Returns
New
Doc
Root
Query
Selector
Schema
Definition
Schema
Definition
Property
Schema
Definition
Type
Schema
Definition
With
Built
In
Class
Schema
Options
Virtuals
Property
Type
Schema
Post
Options
Schema
Pre
Options
Schema
Validator
Set
Expression
Operator
Set
Expression
Operator
Returning
Array
Set
Expression
Operator
Returning
Boolean
Sort
Order
Sort
Values
Special
Path
Variables
Start
Of
Week
String
Expression
String
Expression
Operator
String
Expression
Operator
Returning
Array
String
Expression
Operator
Returning
Boolean
String
Expression
Operator
Returning
Number
String
Expression
Operator
Returning
Object
String
Expression
Operator
Returning
String
String
Schema
Definition
Sync
Indexes
Error
TVirtual
PathFN
Text
Expression
Operator
Treat
As
Primitives
Trigonometry
Expression
Operator
Type
Expression
Operator
Type
Expression
Operator
Returning
Boolean
Type
Expression
Operator
Returning
Date
Type
Expression
Operator
Returning
Number
Type
Expression
Operator
Returning
Object
Id
Type
Expression
Operator
Returning
String
Type
Key
Base
Type
UTCOffset
Unpacked
Unpacked
Intersection
Update
Aggregation
Stage
Update
Query
Update
Query
Known
Only
Update
With
Aggregation
Pipeline
Update
Write
Op
Result
Variable
Expression
Operator
Variable
Expression
Operator
Returning
Any
Virtual
Path
Functions
Window
Operator
Window
Operator
Returning
Any
Window
Operator
Returning
Array
Window
Operator
Returning
Number
Write
Concern
_
Filter
Query
_pick
Object
actual
Primitives
hh
mm
paths
To
Skip
paths
To
Validate
tz
Expression
Collection
Model
Mongoose
Promise
STATES
Schema
Types
connection
connections
models
version
connect
create
Connection
delete
Model
disconnect
get
is
Object
Id
Or
Hex
String
is
Valid
Object
Id
model
model
Names
now
plugin
pluralize
sanitize
Filter
set
set
Driver
start
Session
sync
Indexes
trusted
types
Prop
Type
Severity
MongoDBCant
Connect
Error
MongoDBConnection
Not
Exists
Error
MongoDBConnector
Passthrough
Array
Prop
Options
Base
Prop
Options
Decorated
Property
Metadata
Discriminator
Object
Enum
Obj
Get
Type
Return
IBuild
Schema
Options
ICustom
Options
IGlobal
Options
IHooks
Array
IIndex
Array
IModel
Options
IMongoDBConfig
INaming
Options
IObject
With
Typegoose
Function
IPlugins
Array
IPrototype
ITypegoose
Options
Inner
Outer
Options
Map
Prop
Options
Mapped
Inner
Outer
Options
Process
Prop
Options
Transform
String
Options
Validate
Number
Options
Validate
String
Options
Virtual
Options
Any
Param
Constructor
Array
Sub
Document
Type
As
Query
Method
Be
An
Object
Be
Any
Object
Custom
Name
Function
Decorated
Property
Metadata
Map
Deferred
Func
Document
Type
Dynamic
String
Func
Enum
Combined
Type
Enum
Values
Filter
Out
Function
Keys
Func
Get
Function
Keys
Hook
Options
Either
IMongoDBConnection
IMongoDBConnector
Index
Options
Key
String
Any
Model
Type
Nested
Discriminators
Function
Nested
Discriminators
Map
Prop
Options
For
Number
Prop
Options
For
String
Query
Helper
This
Query
Method
Map
Ref
Ref
Type
Return
Model
Type
Sub
Document
Type
Virtual
Populate
Map
Log
Levels
Post
Pre
add
Model
To
Typegoose
build
Schema
delete
Model
delete
Model
With
Class
get
Class
get
Discriminator
Model
For
Class
get
Model
For
Class
get
Model
With
String
get
Name
index
is
Document
is
Document
Array
is
Model
is
Ref
Type
is
Ref
Type
Array
model
model
Options
plugin
post
pre
prop
query
Method
set
Global
Options
set
Log
Level
mssql
nestjs-
tools
opensearch
pg
playwright
prometheus
proxy
proxy-
prometheus
rdkafka
react-
virtual-
table
redis
run-
context
schema-
registry
sequelize
shutdown-
hook
symbolic
tools
vault
Generated using
TypeDoc
$samplereference