Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

Properties

Methods

  • getBuiltinCommands(): string[]
  • createBuiltinCommand(commandName: string): {}
  • defineCommand(name: string, definition: { numberOfKeys?: number; lua?: string }): void
  • Parameters

    • name: string
    • definition: { numberOfKeys?: number; lua?: string }
      • Optional numberOfKeys?: number
      • Optional lua?: string

    Returns void

  • sendCommand(): void
  • Returns void

  • brpoplpush(source: string, destination: string, timeout: number, callback: <internal>.IORedis.Callback<string>): void
  • brpoplpush(source: string, destination: string, timeout: number): Promise<string>
  • Parameters

    Returns void

  • Parameters

    • source: string
    • destination: string
    • timeout: number

    Returns Promise<string>

  • rpoplpush(source: string, destination: string, callback: <internal>.IORedis.Callback<string>): void
  • rpoplpush(source: string, destination: string): Promise<string>
  • Parameters

    Returns void

  • Parameters

    • source: string
    • destination: string

    Returns Promise<string>

  • georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", callback: <internal>.IORedis.Callback<string[]>): void
  • georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC"): Promise<string[]>
  • georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC"): Promise<string[]>
  • Parameters

    Returns void

  • Parameters

    • key: <internal>.IORedis.KeyType
    • longitude: number
    • latitude: number
    • radius: number
    • unit: "m" | "km" | "ft" | "mi"
    • Optional sort: "ASC" | "DESC"

    Returns Promise<string[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • longitude: number
    • latitude: number
    • radius: number
    • unit: "m" | "km" | "ft" | "mi"
    • count: "COUNT"
    • countValue: number
    • Optional sort: "ASC" | "DESC"

    Returns Promise<string[]>

  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): Promise<string[] | (string[] | string[][])[]>
  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMMEMBER"
    • member: string
    • by: "BYRADIUS"
    • radius: number
    • radiusUnit: "m" | "km" | "ft" | "mi"
    • count: "COUNT"
    • countValue: number
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMMEMBER"
    • member: string
    • by: "BYBOX"
    • width: number
    • height: number
    • unit: "m" | "km" | "ft" | "mi"
    • count: "COUNT"
    • countValue: number
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMLONLAT"
    • longitude: number
    • latitude: number
    • by: "BYRADIUS"
    • radius: number
    • radiusUnit: "m" | "km" | "ft" | "mi"
    • count: "COUNT"
    • countValue: number
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMLONLAT"
    • longitude: number
    • latitude: number
    • by: "BYBOX"
    • width: number
    • height: number
    • unit: "m" | "km" | "ft" | "mi"
    • count: "COUNT"
    • countValue: number
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMMEMBER"
    • member: string
    • by: "BYRADIUS"
    • radius: number
    • radiusUnit: "m" | "km" | "ft" | "mi"
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMMEMBER"
    • member: string
    • by: "BYBOX"
    • width: number
    • height: number
    • unit: "m" | "km" | "ft" | "mi"
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMLONLAT"
    • longitude: number
    • latitude: number
    • by: "BYRADIUS"
    • radius: number
    • radiusUnit: "m" | "km" | "ft" | "mi"
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    • key: <internal>.IORedis.KeyType
    • from: "FROMLONLAT"
    • longitude: number
    • latitude: number
    • by: "BYBOX"
    • width: number
    • height: number
    • unit: "m" | "km" | "ft" | "mi"
    • Optional sort: "ASC" | "DESC"
    • Optional withCoord: "WITHCOORD"
    • Optional withDist: "WITHDIST"
    • Optional withHash: "WITHHASH"

    Returns Promise<string[] | (string[] | string[][])[]>

  • Parameters

    Returns void

  • Parameters

    • index: number

    Returns Promise<"OK">

  • Parameters

    Returns void

  • Parameters

    • pattern: string

    Returns Promise<string[]>

  • auth(username: string, password: string, callback: <internal>.IORedis.Callback<string>): void
  • auth(password: string, callback: <internal>.IORedis.Callback<string>): void
  • auth(username: string, password: string): Promise<string>
  • auth(password: string): Promise<string>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • username: string
    • password: string

    Returns Promise<string>

  • Parameters

    • password: string

    Returns Promise<string>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • Optional message: string

    Returns Promise<string>

  • Parameters

    Returns void

  • Parameters

    • message: string

    Returns Promise<string>

  • Parameters

    Returns void

  • Returns Promise<string>

  • shutdown(save: "SAVE" | "NOSAVE", callback: <internal>.IORedis.Callback<never>): void
  • shutdown(save: "SAVE" | "NOSAVE"): Promise<never>
  • Parameters

    Returns void

  • Parameters

    • save: "SAVE" | "NOSAVE"

    Returns Promise<never>

  • Parameters

    Returns void

  • Returns Promise<[Error, string][]>

  • Parameters

    Returns void

  • Returns Promise<any>

  • Parameters

    Returns void

  • Parameters

    • Optional option: "async" | "sync"

    Returns Promise<"OK">

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • Optional section: string

    Returns Promise<string>

  • Parameters

    Returns void

  • Returns Promise<[string, string]>

  • slaveof(host: string, port: number, callback: <internal>.IORedis.Callback<string>): void
  • slaveof(host: string, port: number): Promise<string>
  • Parameters

    Returns void

  • Parameters

    • host: string
    • port: number

    Returns Promise<string>

  • publish(channel: string, message: string, callback: <internal>.IORedis.Callback<number>): void
  • publish(channel: string, message: string): Promise<number>
  • Parameters

    Returns void

  • Parameters

    • channel: string
    • message: string

    Returns Promise<number>

  • Parameters

    Returns void

  • Returns Promise<"OK">

  • scan(cursor: string | number): Promise<[string, string[]]>
  • scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string): Promise<[string, string[]]>
  • scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, callback: <internal>.IORedis.Callback<[string, string[]]>): void
  • scan(cursor: string | number, countOption: "count" | "COUNT", count: number): Promise<[string, string[]]>
  • scan(cursor: string | number, countOption: "count" | "COUNT", count: number, callback: <internal>.IORedis.Callback<[string, string[]]>): void
  • scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, countOption: "count" | "COUNT", count: number): Promise<[string, string[]]>
  • scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, countOption: "count" | "COUNT", count: number, callback: <internal>.IORedis.Callback<[string, string[]]>): void
  • scan(cursor: string | number, countOption: "count" | "COUNT", count: number, matchOption: "match" | "MATCH", pattern: string): Promise<[string, string[]]>
  • scan(cursor: string | number, countOption: "count" | "COUNT", count: number, matchOption: "match" | "MATCH", pattern: string, callback: <internal>.IORedis.Callback<[string, string[]]>): void
  • Parameters

    • cursor: string | number

    Returns Promise<[string, string[]]>

  • Parameters

    • cursor: string | number
    • matchOption: "match" | "MATCH"
    • pattern: string

    Returns Promise<[string, string[]]>

  • Parameters

    • cursor: string | number
    • matchOption: "match" | "MATCH"
    • pattern: string
    • callback: <internal>.IORedis.Callback<[string, string[]]>

    Returns void

  • Parameters

    • cursor: string | number
    • countOption: "count" | "COUNT"
    • count: number

    Returns Promise<[string, string[]]>

  • Parameters

    Returns void

  • Parameters

    • cursor: string | number
    • matchOption: "match" | "MATCH"
    • pattern: string
    • countOption: "count" | "COUNT"
    • count: number

    Returns Promise<[string, string[]]>

  • Parameters

    • cursor: string | number
    • matchOption: "match" | "MATCH"
    • pattern: string
    • countOption: "count" | "COUNT"
    • count: number
    • callback: <internal>.IORedis.Callback<[string, string[]]>

    Returns void

  • Parameters

    • cursor: string | number
    • countOption: "count" | "COUNT"
    • count: number
    • matchOption: "match" | "MATCH"
    • pattern: string

    Returns Promise<[string, string[]]>

  • Parameters

    • cursor: string | number
    • countOption: "count" | "COUNT"
    • count: number
    • matchOption: "match" | "MATCH"
    • pattern: string
    • callback: <internal>.IORedis.Callback<[string, string[]]>

    Returns void

  • connect(callback?: (() => void)): Promise<void>
  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns Promise<void>

  • disconnect(reconnect?: boolean): void
  • Parameters

    • Optional reconnect: boolean

    Returns void

  • Parameters

    Returns Promise<any>

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IORedis.Redis

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IORedis.Redis

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IORedis.Redis

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IORedis.Redis

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IORedis.Redis

  • getMaxListeners(): number
  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IORedis.Redis

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

Properties

geohash: <internal>.IORedis.OverloadedKeyCommand<string, string[]>
geopos: <internal>.IORedis.OverloadedKeyCommand<string, string[]>
subscribe: <internal>.IORedis.OverloadedListCommand<string, number>
unsubscribe: <internal>.IORedis.OverloadedCommand<string, number>
psubscribe: <internal>.IORedis.OverloadedListCommand<string, number>
punsubscribe: <internal>.IORedis.OverloadedCommand<string, number>
pfadd: <internal>.IORedis.OverloadedKeyCommand<string, number>
xautoclaim: <internal>.IORedis.OverloadedSubCommand<<internal>.IORedis.ValueType, [string, [string, string[]][]]>
xread: <internal>.IORedis.OverloadedListCommand<<internal>.IORedis.ValueType, [string, [string, string[]][]][]>
xreadgroup: <internal>.IORedis.OverloadedKeyCommand<<internal>.IORedis.ValueType, [string, [string, string[]][]][]>
Promise: PromiseConstructor
status: string

Generated using TypeDoc