Class ComputeOptions

Custom type to facilitate type checking for global options

Implements

Options

Index

Accessors

collation collectionResolver context hashFunction idKey jsonSchemaValidator local processingMode root scriptEnabled useGlobalContext useStrictMode variables

Methods

getOptions update init

Accessors

collation

get collation(): CollationSpec
The collation specification for string sorting operations.

Returns CollationSpec
Implementation of Options.collation
- Defined in src/core.ts:166

collectionResolver

get collectionResolver(): CollectionResolver
Function to resolve strings to arrays for use with operators that reference other collections such as; $lookup, $out and $merge.

Returns CollectionResolver
Implementation of Options.collectionResolver
- Defined in src/core.ts:184

context

get context(): Context
Extra references to operators to be used for processing.

Returns Context
Implementation of Options.context
- Defined in src/core.ts:193

hashFunction

get hashFunction(): HashFunction
Hash function to replace the Effective Java default implementation.

Returns HashFunction
Implementation of Options.hashFunction
- Defined in src/core.ts:181

idKey

get idKey(): string
The key that is used to lookup the ID value of a document.

Returns string
Default
```
"_id".
```
Implementation of Options.idKey
- Defined in src/core.ts:163

jsonSchemaValidator

get jsonSchemaValidator(): JsonSchemaValidator
JSON schema validator to use with the '$jsonSchema' operator. Required in order to use the operator.

Returns JsonSchemaValidator
Implementation of Options.jsonSchemaValidator
- Defined in src/core.ts:187

local

get local(): LocalData
Returns LocalData
- Defined in src/core.ts:160

processingMode

get processingMode(): ProcessingMode
Determines how to treat inputs and outputs.

Returns ProcessingMode
Default
```
ProcessingMode.CLONE_OFF.
```
Implementation of Options.processingMode
- Defined in src/core.ts:169

root

get root(): unknown
Returns unknown
- Defined in src/core.ts:157

scriptEnabled

get scriptEnabled(): boolean
Enable or disable custom script execution using $where, $accumulator, and $function operators.

Returns boolean
Default
```
true.
```
Implementation of Options.scriptEnabled
- Defined in src/core.ts:175

useGlobalContext

get useGlobalContext(): boolean
Enable or disable falling back to the global context for operators.

Returns boolean
Default
```
true.
```
Implementation of Options.useGlobalContext
- Defined in src/core.ts:178

useStrictMode

get useStrictMode(): boolean
Enforces strict MongoDB compatibilty. See README.

Returns boolean
Default
```
true.
```
Implementation of Options.useStrictMode
- Defined in src/core.ts:172

variables

get variables(): Readonly<AnyObject>
Global variables.

Returns Readonly<AnyObject>
Implementation of Options.variables
- Defined in src/core.ts:190

Methods

getOptions

getOptions(): Options
Returns Options
- Defined in src/core.ts:150

update

update(root?: unknown, local?: LocalData): ComputeOptions
Updates the internal state.
Parameters
- Optionalroot: unknown
  The new root context for this object.
- Optionallocal: LocalData
  The new local state to merge into current if it exists.
Returns ComputeOptions
- Defined in src/core.ts:133

`Static`init

init(options: Options, root?: unknown, local?: LocalData): ComputeOptions
Initialize new ComputeOptions.
Parameters
- options: Options
- Optionalroot: unknown
- Optionallocal: LocalData
Returns ComputeOptions
- Defined in src/core.ts:112