Class ComputeOptions

Readonly timestamp

collation

• get collation(): CollationSpec

• The collation specification for string sorting operations.

  Returns CollationSpec

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

context

• get context(): Context

• Extra references to operators to be used for processing.

  Returns Context

hashFunction

• get hashFunction(): HashFunction

• Hash function to replace the Effective Java default implementation.

  Returns HashFunction

idKey

• get idKey(): string

• The key that is used to lookup the ID value of a document.

  Returns string

  Default

  "_id".
  Copy

jsonSchemaValidator

• get jsonSchemaValidator(): JsonSchemaValidator

• JSON schema validator to use with the '$jsonSchema' operator. Required in order to use the operator.

  Returns JsonSchemaValidator

local

• get local(): LocalData

• Returns LocalData

processingMode

• get processingMode(): ProcessingMode

• Determines how to treat inputs and outputs.

  Returns ProcessingMode

  Default

  ProcessingMode.CLONE_OFF.
  Copy

root

• get root(): unknown

• Returns unknown

scriptEnabled

• get scriptEnabled(): boolean

• Enable or disable custom script execution via $where, $accumulator, and $function operators.

  Returns boolean

  Default

  true.
  Copy

useGlobalContext

• get useGlobalContext(): boolean

• Enable or disable falling back to the global context for operators.

  Returns boolean

  Default

  true.
  Copy

useStrictMode

• get useStrictMode(): boolean

• Enforces strict MongoDB compatibilty. See README.

  Returns boolean

  Default

  true.
  Copy

variables

• get variables(): Readonly<RawObject>

• Global variables.

  Returns Readonly<RawObject>

getOptions

• getOptions(): Options

• Returns Options

update

• update(root?, local?): ComputeOptions

• Updates the internal mutable state.

  Parameters

  • Optional root: unknown
  • Optional local: LocalData

  Returns ComputeOptions

Static init

• init(options, root?, local?): ComputeOptions

• Initialize new ComputeOptions.

  Parameters

  • options: Options
  • Optional root: unknown
  • Optional local: LocalData

  Returns ComputeOptions