Class ComputeOptions

Readonlyoptions

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(): Locals

  Returns Locals

processingMode

• get processingMode(): ProcessingMode

  Determines how to treat inputs and outputs.

  Returns ProcessingMode

  Default

  ProcessingMode.CLONE_OFF.
  Copy

scriptEnabled

• get scriptEnabled(): boolean

  Enable or disable custom script execution using $where, $accumulator, and $function 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<AnyObject>

  Global variables.

  Returns Readonly<AnyObject>

update

• update(locals?: Omit<Locals, "now">): ComputeOptions

  Parameters

  • Optionallocals: Omit<Locals, "now">

  Returns ComputeOptions

Staticinit

• init(options: Partial<Options>): ComputeOptions

  Initializes a new instance of the ComputeOptions class with the provided options.

  Parameters

  • options: Partial<Options>

    A partial set of options to configure the ComputeOptions instance. If an instance of ComputeOptions is provided, its internal options and locals are used.

  Returns ComputeOptions

  A new ComputeOptions instance configured with the provided options and root.