Constructors
constructor
new Client( indexName: string , conn: C ) : Client
Parameters
indexName: string
conn: C
Properties
Private indexName
indexName: string
Methods
Private _addDocument
_addDocument<T>( conn: Redis | null , docId: string , fields: T , score?: number , payload?: Object , noSave?: boolean , replace?: boolean , partial?: boolean ) : Promise < "OK" >
Type parameters
Parameters
conn: Redis | null
docId: string
fields: T
Default value score: number = 1
Optional payload: Object
Default value noSave: boolean = false
Default value replace: boolean = false
Default value partial: boolean = false
Returns Promise < "OK" >
addDocument
addDocument<T>( docId: string , fields: T , score?: number , payload?: Object , noSave?: boolean , replace?: boolean , partial?: boolean ) : Promise < "OK" >
Type parameters
Parameters
docId: string
fields: T
Default value score: number = 1
Optional payload: Object
Default value noSave: boolean = false
Default value replace: boolean = false
Default value partial: boolean = false
Returns Promise < "OK" >
createIndex
createIndex( fields: Field [] ) : Promise < "OK" >
Parameters
Returns Promise < "OK" >
dropIndex
dropIndex( ) : Promise < "OK" >
search
search<T, S>( queryOrString: Query | string , snippetSizes?: S ) : Promise < Result < T , S > >
Type parameters
Parameters
queryOrString: Query | string
Optional snippetSizes: S
Returns Promise < Result < T , S > >
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
addDocument