Document | ioredisearch

Represents a single document in a result set

Hierarchy

Document

Index

Constructors

constructor

Properties

id
payload

Methods

snippetize

Constructors

constructor

new Document(id: string, fields: Object, payload?: Object | null): Document

- Defined in document.ts:9
Parameters
- id: string
- fields: Object
- Default value payload: Object | null = null
Returns Document

Properties

id

id: string

payload

payload: Object

Methods

snippetize

snippetize(field: string, size?: number, boldTokens: string[]): void

- Defined in document.ts:24
Create a shortened snippet from the document's content

Parameters
- field: string
- Default value size: number = 500
  
  the size of the snippet in characters. It might be a bit longer or shorter
- boldTokens: string[]
  
  a list of tokens we want to make bold (basically the query terms)
Returns void

Generated using TypeDoc