Search.md

redis-om / Search

Class: Search<TEntity>

Type parameters

Name	Type
TEntity	extends Entity

Table of contents

Constructors

• constructor

Accessors

• query

Methods

• and
• count
• or
• return
• returnAll
• where

Constructors

constructor

• new Search<TEntity>(schema, client)

Type parameters

Name	Type
TEntity	extends Entity<TEntity>

Parameters

Name	Type
schema	Schema<TEntity>
client	Client

Defined in

lib/search/search.ts:26

Accessors

query

• get query(): string

Returns

string

Defined in

lib/search/search.ts:31

Methods

and

▸ and(field): WhereField<TEntity>

Parameters

Name	Type
field	string

Returns

WhereField<TEntity>

Defined in

lib/search/search.ts:71

▸ and(subSearchFn): Search<TEntity>

Parameters

Name	Type
subSearchFn	SubSearchFunction<TEntity>

Returns

Search<TEntity>

Defined in

lib/search/search.ts:72

---

count

▸ count(): Promise<number>

Returns

Promise<number>

Defined in

lib/search/search.ts:36

---

or

▸ or(field): WhereField<TEntity>

Parameters

Name	Type
field	string

Returns

WhereField<TEntity>

Defined in

lib/search/search.ts:77

▸ or(subSearchFn): Search<TEntity>

Parameters

Name	Type
subSearchFn	SubSearchFunction<TEntity>

Returns

Search<TEntity>

Defined in

lib/search/search.ts:78

---

return

▸ return(offset, pageSize): Promise<TEntity[]>

Parameters

Name	Type
offset	number
pageSize	number

Returns

Promise<TEntity[]>

Defined in

lib/search/search.ts:43

---

returnAll

▸ returnAll(options?): Promise<TEntity[]>

Parameters

Name	Type	Default value
options	Object	undefined
options.pageSize	number	10

Returns

Promise<TEntity[]>

Defined in

lib/search/search.ts:50

---

where

▸ where(field): WhereField<TEntity>

Parameters

Name	Type
field	string

Returns

WhereField<TEntity>

Defined in

lib/search/search.ts:65

▸ where(subSearchFn): Search<TEntity>

Parameters

Name	Type
subSearchFn	SubSearchFunction<TEntity>

Returns

Search<TEntity>

Defined in

lib/search/search.ts:66