Hierarchy

  • SearchOptions

Properties

DIALECT?: number
EXPANDER?: string
HIGHLIGHT?: true | {
    FIELDS?: `@${string}` | `$.${string}` | (`@${string}` | `$.${string}`)[];
    TAGS?: {
        close: string;
        open: string;
    };
}

Type declaration

  • Optional FIELDS?: `@${string}` | `$.${string}` | (`@${string}` | `$.${string}`)[]
  • Optional TAGS?: {
        close: string;
        open: string;
    }
    • close: string
    • open: string
INFIELDS?: string | string[]
INKEYS?: string | string[]
INORDER?: true
LIMIT?: {
    from: string | number;
    size: string | number;
}

Type declaration

  • from: string | number
  • size: string | number
NOSTOPWORDS?: true
PARAMS?: Params
RETURN?: string | string[]
SCORER?: string
SLOP?: number
SUMMARIZE?: true | {
    FIELDS?: `@${string}` | `$.${string}` | (`@${string}` | `$.${string}`)[];
    FRAGS?: number;
    LEN?: number;
    SEPARATOR?: string;
}

Type declaration

  • Optional FIELDS?: `@${string}` | `$.${string}` | (`@${string}` | `$.${string}`)[]
  • Optional FRAGS?: number
  • Optional LEN?: number
  • Optional SEPARATOR?: string
TIMEOUT?: number
VERBATIM?: true
WITHSORTKEYS?: true

Generated using TypeDoc