Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the result of a search query, and has an array of Document objects

Type parameters

  • T

  • S

Hierarchy

  • Result

Index

Constructors

Properties

Constructors

constructor

  • new Result(res: any[], hasContent: boolean, query: string, hasPayload?: boolean, duration?: number, snippets?: S): Result
  • Parameters

    • res: any[]
    • hasContent: boolean
    • query: string
    • Default value hasPayload: boolean = false
    • Default value duration: number = 0
    • Optional snippets: S

      An optional dictionary of the form {field: snippet_size} for snippet formatting

    Returns Result

Properties

docs

docs: (Document & T)[] = []

duration

duration: number

total

total: number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc