Search
Preparing search index...
The search index is not available
@node-redis/search
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@node-redis/search
commands
Module commands
Index
Enumerations
Redis
Search
Languages
Schema
Field
Types
Schema
Text
Field
Phonetics
Interfaces
Create
Schema
Profile
Options
Profile
Reply
Search
Reply
Type aliases
Profile
Raw
Reply
Property
Name
Sort
By
Property
Properties
default
Functions
push
Arguments
With
Length
push
Schema
push
Search
Options
push
Sort
By
Arguments
push
Sort
By
Property
transform
Profile
Type aliases
Profile
Raw
Reply
Profile
Raw
Reply
<
T
>
:
[
results
:
T
,
profile
:
[
_
:
string
,
TotalProfileTime
:
string
,
_
:
string
,
ParsingTime
:
string
,
_
:
string
,
PipelineCreationTime
:
string
,
_
:
string
,
IteratorsProfile
:
any
[]
]
]
Type parameters
T
Property
Name
Property
Name
:
`
${
"@"
|
"$."
}
${
string
}
`
Sort
By
Property
Sort
By
Property
:
PropertyName
|
{
BY
:
PropertyName
;
DIRECTION
?:
"ASC"
|
"DESC"
}
Properties
default
default
:
{
AGGREGATE
:
commands/AGGREGATE
;
ALIASADD
:
commands/ALIASADD
;
ALIASDEL
:
commands/ALIASDEL
;
ALIASUPDATE
:
commands/ALIASUPDATE
;
ALTER
:
commands/ALTER
;
CONFIG_GET
:
commands/CONFIG_GET
;
CONFIG_SET
:
commands/CONFIG_SET
;
CREATE
:
commands/CREATE
;
DICTADD
:
commands/DICTADD
;
DICTDEL
:
commands/DICTDEL
;
DICTDUMP
:
commands/DICTDUMP
;
DROPINDEX
:
commands/DROPINDEX
;
EXPLAIN
:
commands/EXPLAIN
;
EXPLAINCLI
:
commands/EXPLAINCLI
;
INFO
:
commands/INFO
;
PROFILEAGGREGATE
:
commands/PROFILE_AGGREGATE
;
PROFILESEARCH
:
commands/PROFILE_SEARCH
;
SEARCH
:
commands/SEARCH
;
SPELLCHECK
:
commands/SPELLCHECK
;
SUGADD
:
commands/SUGADD
;
SUGDEL
:
commands/SUGDEL
;
SUGGET
:
commands/SUGGET
;
SUGGET_WITHPAYLOADS
:
commands/SUGGET_WITHPAYLOADS
;
SUGGET_WITHSCORES
:
commands/SUGGET_WITHSCORES
;
SUGGET_WITHSCORES_WITHPAYLOADS
:
commands/SUGGET_WITHSCORES_WITHPAYLOADS
;
SUGLEN
:
commands/SUGLEN
;
SYNDUMP
:
commands/SYNDUMP
;
SYNUPDATE
:
commands/SYNUPDATE
;
TAGVALS
:
commands/TAGVALS
;
_LIST
:
commands/_LIST
;
_list
:
commands/_LIST
;
aggregate
:
commands/AGGREGATE
;
aliasAdd
:
commands/ALIASADD
;
aliasDel
:
commands/ALIASDEL
;
aliasUpdate
:
commands/ALIASUPDATE
;
alter
:
commands/ALTER
;
configGet
:
commands/CONFIG_GET
;
configSet
:
commands/CONFIG_SET
;
create
:
commands/CREATE
;
dictAdd
:
commands/DICTADD
;
dictDel
:
commands/DICTDEL
;
dictDump
:
commands/DICTDUMP
;
dropIndex
:
commands/DROPINDEX
;
explain
:
commands/EXPLAIN
;
explainCli
:
commands/EXPLAINCLI
;
info
:
commands/INFO
;
profileAggregate
:
commands/PROFILE_AGGREGATE
;
profileSearch
:
commands/PROFILE_SEARCH
;
search
:
commands/SEARCH
;
spellCheck
:
commands/SPELLCHECK
;
sugAdd
:
commands/SUGADD
;
sugDel
:
commands/SUGDEL
;
sugGet
:
commands/SUGGET
;
sugGetWithPayloads
:
commands/SUGGET_WITHPAYLOADS
;
sugGetWithScores
:
commands/SUGGET_WITHSCORES
;
sugGetWithScoresWithPayloads
:
commands/SUGGET_WITHSCORES_WITHPAYLOADS
;
sugLen
:
commands/SUGLEN
;
synDump
:
commands/SYNDUMP
;
synUpdate
:
commands/SYNUPDATE
;
tagVals
:
commands/TAGVALS
}
Type declaration
AGGREGATE
:
commands/AGGREGATE
ALIASADD
:
commands/ALIASADD
ALIASDEL
:
commands/ALIASDEL
ALIASUPDATE
:
commands/ALIASUPDATE
ALTER
:
commands/ALTER
CONFIG_
GET
:
commands/CONFIG_GET
CONFIG_
SET
:
commands/CONFIG_SET
CREATE
:
commands/CREATE
DICTADD
:
commands/DICTADD
DICTDEL
:
commands/DICTDEL
DICTDUMP
:
commands/DICTDUMP
DROPINDEX
:
commands/DROPINDEX
EXPLAIN
:
commands/EXPLAIN
EXPLAINCLI
:
commands/EXPLAINCLI
INFO
:
commands/INFO
PROFILEAGGREGATE
:
commands/PROFILE_AGGREGATE
PROFILESEARCH
:
commands/PROFILE_SEARCH
SEARCH
:
commands/SEARCH
SPELLCHECK
:
commands/SPELLCHECK
SUGADD
:
commands/SUGADD
SUGDEL
:
commands/SUGDEL
SUGGET
:
commands/SUGGET
SUGGET_
WITHPAYLOADS
:
commands/SUGGET_WITHPAYLOADS
SUGGET_
WITHSCORES
:
commands/SUGGET_WITHSCORES
SUGGET_
WITHSCORES_
WITHPAYLOADS
:
commands/SUGGET_WITHSCORES_WITHPAYLOADS
SUGLEN
:
commands/SUGLEN
SYNDUMP
:
commands/SYNDUMP
SYNUPDATE
:
commands/SYNUPDATE
TAGVALS
:
commands/TAGVALS
_LIST
:
commands/_LIST
_list
:
commands/_LIST
aggregate
:
commands/AGGREGATE
alias
Add
:
commands/ALIASADD
alias
Del
:
commands/ALIASDEL
alias
Update
:
commands/ALIASUPDATE
alter
:
commands/ALTER
config
Get
:
commands/CONFIG_GET
config
Set
:
commands/CONFIG_SET
create
:
commands/CREATE
dict
Add
:
commands/DICTADD
dict
Del
:
commands/DICTDEL
dict
Dump
:
commands/DICTDUMP
drop
Index
:
commands/DROPINDEX
explain
:
commands/EXPLAIN
explain
Cli
:
commands/EXPLAINCLI
info
:
commands/INFO
profile
Aggregate
:
commands/PROFILE_AGGREGATE
profile
Search
:
commands/PROFILE_SEARCH
search
:
commands/SEARCH
spell
Check
:
commands/SPELLCHECK
sug
Add
:
commands/SUGADD
sug
Del
:
commands/SUGDEL
sug
Get
:
commands/SUGGET
sug
Get
With
Payloads
:
commands/SUGGET_WITHPAYLOADS
sug
Get
With
Scores
:
commands/SUGGET_WITHSCORES
sug
Get
With
Scores
With
Payloads
:
commands/SUGGET_WITHSCORES_WITHPAYLOADS
sug
Len
:
commands/SUGLEN
syn
Dump
:
commands/SYNDUMP
syn
Update
:
commands/SYNUPDATE
tag
Vals
:
commands/TAGVALS
Functions
push
Arguments
With
Length
push
Arguments
With
Length
(
args
:
RedisCommandArguments
, fn
:
(
args
:
RedisCommandArguments
)
=>
void
)
:
RedisCommandArguments
Parameters
args:
RedisCommandArguments
fn:
(
args
:
RedisCommandArguments
)
=>
void
(
args
:
RedisCommandArguments
)
:
void
Parameters
args:
RedisCommandArguments
Returns
void
Returns
RedisCommandArguments
push
Schema
push
Schema
(
args
:
RedisCommandArguments
, schema
:
CreateSchema
)
:
void
Parameters
args:
RedisCommandArguments
schema:
CreateSchema
Returns
void
push
Search
Options
push
Search
Options
(
args
:
RedisCommandArguments
, options
?:
SearchOptions
)
:
RedisCommandArguments
Parameters
args:
RedisCommandArguments
Optional
options:
SearchOptions
Returns
RedisCommandArguments
push
Sort
By
Arguments
push
Sort
By
Arguments
(
args
:
RedisCommandArguments
, name
:
string
, sortBy
:
SortByProperty
|
SortByProperty
[]
)
:
RedisCommandArguments
Parameters
args:
RedisCommandArguments
name:
string
sortBy:
SortByProperty
|
SortByProperty
[]
Returns
RedisCommandArguments
push
Sort
By
Property
push
Sort
By
Property
(
args
:
RedisCommandArguments
, sortBy
:
SortByProperty
)
:
void
Parameters
args:
RedisCommandArguments
sortBy:
SortByProperty
Returns
void
transform
Profile
transform
Profile
(
reply
:
any
[]
)
:
ProfileData
Parameters
reply:
any
[]
Returns
ProfileData
Modules
commands
commands/AGGREGATE
commands/ALIASADD
commands/ALIASDEL
commands/ALIASUPDATE
commands/ALTER
commands/CONFIG_
GET
commands/CONFIG_
SET
commands/CREATE
commands/DICTADD
commands/DICTDEL
commands/DICTDUMP
commands/DROPINDEX
commands/EXPLAIN
commands/EXPLAINCLI
commands/INFO
commands/PROFILE_
AGGREGATE
commands/PROFILE_
SEARCH
commands/SEARCH
commands/SPELLCHECK
commands/SUGADD
commands/SUGDEL
commands/SUGGET
commands/SUGGET_
WITHPAYLOADS
commands/SUGGET_
WITHSCORES
commands/SUGGET_
WITHSCORES_
WITHPAYLOADS
commands/SUGLEN
commands/SYNDUMP
commands/SYNUPDATE
commands/TAGVALS
commands/_
LIST
index
Redis
Search
Languages
Schema
Field
Types
Schema
Text
Field
Phonetics
Create
Schema
Profile
Options
Profile
Reply
Search
Reply
Profile
Raw
Reply
Property
Name
Sort
By
Property
default
push
Arguments
With
Length
push
Schema
push
Search
Options
push
Sort
By
Arguments
push
Sort
By
Property
transform
Profile
Generated using
TypeDoc