mingo
    Preparing search index...

    Interface Options

    Generic options interface passed down to all operators

    interface Options {
        collation?: CollationSpec;
        collectionResolver?: CollectionResolver;
        context: Context;
        hashFunction?: (x: unknown) => number;
        idKey: string;
        jsonSchemaValidator?: JsonSchemaValidator;
        processingMode: ProcessingMode;
        scriptEnabled: boolean;
        useStrictMode: boolean;
        variables?: Readonly<AnyObject>;
    }

    Implemented by

    Index

    Properties

    collation? collectionResolver? context hashFunction? idKey jsonSchemaValidator? processingMode scriptEnabled useStrictMode variables?

    Properties

    collation?: CollationSpec

    The collation specification for string sorting operations.

    collectionResolver?: CollectionResolver

    Function to resolve strings to arrays for use with operators that reference other collections such as; $lookup, $out and $merge.

    context: Context

    Extra references to operators to be used for processing.

    hashFunction?: (x: unknown) => number

    This option does nothing and will be removed in future versions.

    idKey: string

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

    "_id".
    jsonSchemaValidator?: JsonSchemaValidator

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

    processingMode: ProcessingMode

    Determines how to treat inputs and outputs.

    ProcessingMode.CLONE_OFF.
    scriptEnabled: boolean

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

    true.
    useStrictMode: boolean

    Enforces strict MongoDB compatibilty. See README.

    true.
    variables?: Readonly<AnyObject>

    Global variables.

    Settings

    Member Visibility

    On This Page

    Properties