Class ComputeOptions

Custom type to facilitate type checking for global options

Implements

Options

Index

Constructors

Properties

#local #options #root

Accessors

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

Methods

getOptions update init

Constructors

`Private` constructor

new ComputeOptions(options, root, local?): ComputeOptions
Parameters
- options: Options
- root: unknown
- Optional local: LocalData
Returns ComputeOptions
- Defined in src/core.ts:128

Properties

`Private` #local

#local: LocalData

`Private` #options

#options: Options

`Private` #root

#root: unknown

Reference to the root object when processing subgraphs of the object.

Accessors

collation

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

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

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:214

context

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

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

hashFunction

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

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

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:193

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:217

local

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

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:199

root

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

scriptEnabled

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

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

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:208

useStrictMode

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

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

variables

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

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

Methods

getOptions

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

update

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

`Static` init

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