Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RedisClient

Hierarchy

  • RedisClient

Index

Properties

Methods

Properties

command_queue

command_queue: any[]

connected

connected: boolean

offline_queue

offline_queue: any[]

retry_backoff

retry_backoff: number

retry_delay

retry_delay: number

server_info

server_info: any

Methods

addListener

  • addListener(event: string, callback: Function): any

any

  • any(args: any[], callback?: any): any
  • any(...args: any[]): any

append

  • append(key: string, value: string, callback?: any): boolean
  • append(args: any[], callback?: any): boolean
  • append(...args: any[]): boolean

auth

  • auth(password: string, callback?: any): boolean
  • auth(args: any[], callback?: any): void
  • auth(...args: any[]): void

bgrewriteaof

  • bgrewriteaof(args: any[], callback?: any): boolean
  • bgrewriteaof(...args: any[]): boolean

bgsave

  • bgsave(args: any[], callback?: any): boolean
  • bgsave(...args: any[]): boolean

bitcount

  • bitcount(key: string, callback?: any): boolean
  • bitcount(key: string, start: number, end: number, callback?: any): boolean

blpop

  • blpop(args: any[], callback?: any): boolean
  • blpop(...args: any[]): boolean

brpop

  • brpop(args: any[], callback?: any): boolean
  • brpop(...args: any[]): boolean

brpoplpush

  • brpoplpush(args: any[], callback?: any): boolean
  • brpoplpush(...args: any[]): boolean

client

  • client(args: any[], callback?: any): boolean
  • client(...args: any[]): boolean

cluster

  • cluster(args: any[], callback?: any): boolean
  • cluster(...args: any[]): boolean

config

  • config(args: any[], callback?: any): boolean
  • config(...args: any[]): boolean

cork

  • cork(): void

dbsize

  • dbsize(args: any[], callback?: any): boolean
  • dbsize(...args: any[]): boolean

debug

  • debug(args: any[], callback?: any): boolean
  • debug(...args: any[]): boolean

decr

  • decr(args: any[], callback?: any): boolean
  • decr(...args: any[]): boolean

decrby

  • decrby(args: any[], callback?: any): boolean
  • decrby(...args: any[]): boolean

del

  • del(args: any[], callback?: any): boolean
  • del(...args: any[]): boolean

discard

  • discard(args: any[], callback?: any): boolean
  • discard(...args: any[]): boolean

dump

  • dump(args: any[], callback?: any): boolean
  • dump(...args: any[]): boolean

duplicate

  • duplicate(options?: any[], callback?: any): RedisClient

echo

  • echo(args: any[], callback?: any): boolean
  • echo(...args: any[]): boolean

end

  • end(flush: boolean): void

  • Forcibly close the connection to the Redis server. Note that this does not wait until all replies have been parsed. If you want to exit cleanly, call client.quit()

    Parameters

    • flush: boolean

      You should set flush to true, if you are not absolutely sure you do not care about any other commands. If you set flush to false all still running commands will silently fail.

    Returns void

eval

  • eval(args: any[], callback?: any): boolean
  • eval(...args: any[]): boolean

evalsha

  • evalsha(args: any[], callback?: any): boolean
  • evalsha(...args: any[]): boolean

exec

  • exec(args: any[], callback?: any): boolean
  • exec(...args: any[]): boolean

exists

  • exists(key: string, value: string, callback?: any): boolean
  • exists(args: any[], callback?: any): boolean
  • exists(...args: any[]): boolean

expire

  • expire(args: any[], callback?: any): boolean
  • expire(...args: any[]): boolean

expireat

  • expireat(args: any[], callback?: any): boolean
  • expireat(...args: any[]): boolean

flushall

  • flushall(args: any[], callback?: any): boolean
  • flushall(...args: any[]): boolean

flushdb

  • flushdb(args: any[], callback?: any): boolean
  • flushdb(...args: any[]): boolean

get

  • get(key: string, callback?: any): boolean
  • get(args: any[], callback?: any): boolean
  • get(...args: any[]): boolean

getbit

  • getbit(args: any[], callback?: any): boolean
  • getbit(...args: any[]): boolean

getrange

  • getrange(args: any[], callback?: any): boolean
  • getrange(...args: any[]): boolean

getset

  • getset(args: any[], callback?: any): boolean
  • getset(...args: any[]): boolean

hdel

  • hdel(args: any[], callback?: any): boolean
  • hdel(...args: any[]): boolean

hexists

  • hexists(args: any[], callback?: any): boolean
  • hexists(...args: any[]): boolean

hget

  • hget(args: any[], callback?: any): boolean
  • hget(...args: any[]): boolean

hgetall

  • hgetall(args: any[], callback?: any): boolean
  • hgetall(...args: any[]): boolean
  • hgetall(key: string, callback?: any): boolean

hincrby

  • hincrby(args: any[], callback?: any): boolean
  • hincrby(...args: any[]): boolean

hincrbyfloat

  • hincrbyfloat(args: any[], callback?: any): boolean
  • hincrbyfloat(...args: any[]): boolean

hkeys

  • hkeys(args: any[], callback?: any): boolean
  • hkeys(...args: any[]): boolean

hlen

  • hlen(args: any[], callback?: any): boolean
  • hlen(...args: any[]): boolean

hmget

  • hmget(args: any[], callback?: any): boolean
  • hmget(...args: any[]): boolean

hmset

  • hmset(args: any[], callback?: any): boolean
  • hmset(key: string, hash: any, callback?: any): boolean
  • hmset(...args: any[]): boolean

hscan

  • hscan(...args: any[]): boolean
  • hscan(args: any[], callback?: any): boolean

hset

  • hset(args: any[], callback?: any): boolean
  • hset(...args: any[]): boolean

hsetnx

  • hsetnx(args: any[], callback?: any): boolean
  • hsetnx(...args: any[]): boolean

hvals

  • hvals(args: any[], callback?: any): boolean
  • hvals(...args: any[]): boolean

incr

  • incr(args: any[], callback?: any): boolean
  • incr(...args: any[]): boolean

incrby

  • incrby(args: any[], callback?: any): boolean
  • incrby(...args: any[]): boolean

info

  • info(args: any[], callback?: any): boolean
  • info(...args: any[]): boolean

keys

  • keys(args: any[], callback?: any): boolean
  • keys(...args: any[]): boolean

lastsave

  • lastsave(args: any[], callback?: any): boolean
  • lastsave(...args: any[]): boolean

lindex

  • lindex(args: any[], callback?: any): boolean
  • lindex(...args: any[]): boolean

linsert

  • linsert(args: any[], callback?: any): boolean
  • linsert(...args: any[]): boolean

llen

  • llen(args: any[], callback?: any): boolean
  • llen(...args: any[]): boolean

lpop

  • lpop(args: any[], callback?: any): boolean
  • lpop(...args: any[]): boolean

lpush

  • lpush(args: any[], callback?: any): boolean
  • lpush(...args: any[]): boolean

lpushx

  • lpushx(args: any[], callback?: any): boolean
  • lpushx(...args: any[]): boolean

lrange

  • lrange(args: any[], callback?: any): boolean
  • lrange(...args: any[]): boolean

lrem

  • lrem(args: any[], callback?: any): boolean
  • lrem(...args: any[]): boolean

lset

  • lset(args: any[], callback?: any): boolean
  • lset(...args: any[]): boolean

ltrim

  • ltrim(args: any[], callback?: any): boolean
  • ltrim(...args: any[]): boolean

mget

  • mget(args: any[], callback?: any): boolean
  • mget(...args: any[]): boolean

migrate

  • migrate(args: any[], callback?: any): boolean
  • migrate(...args: any[]): boolean

monitor

  • monitor(args: any[], callback?: any): boolean
  • monitor(...args: any[]): boolean

move

  • move(args: any[], callback?: any): boolean
  • move(...args: any[]): boolean

mset

  • mset(args: any[], callback?: any): boolean
  • mset(...args: any[]): boolean

msetnx

  • msetnx(args: any[], callback?: any): boolean
  • msetnx(...args: any[]): boolean

object

  • object(args: any[], callback?: any): boolean
  • object(...args: any[]): boolean

off

  • off(event: string, callback: Function): any

on

  • on(event: string, callback: Function): any

persist

  • persist(args: any[], callback?: any): boolean
  • persist(...args: any[]): boolean

ping

  • ping(callback?: any): boolean
  • ping(args: any[], callback?: any): boolean
  • ping(...args: any[]): boolean

psubscribe

  • psubscribe(args: any[], callback?: any): boolean
  • psubscribe(...args: any[]): boolean

publish

  • publish(channel: string, value: any): boolean
  • publish(args: any[], callback?: any): boolean
  • publish(...args: any[]): boolean

punsubscribe

  • punsubscribe(args: any[], callback?: any): boolean
  • punsubscribe(...args: any[]): boolean

quit

  • quit(args: any[], callback?: any): boolean
  • quit(...args: any[]): boolean

randomkey

  • randomkey(args: any[], callback?: any): boolean
  • randomkey(...args: any[]): boolean

rename

  • rename(args: any[], callback?: any): boolean
  • rename(...args: any[]): boolean

renamenx

  • renamenx(args: any[], callback?: any): boolean
  • renamenx(...args: any[]): boolean

restore

  • restore(args: any[], callback?: any): boolean
  • restore(...args: any[]): boolean

rpop

  • rpop(args: any[], callback?: any): boolean
  • rpop(...args: any[]): boolean

rpoplpush

  • rpoplpush(args: any[], callback?: any): boolean
  • rpoplpush(...args: any[]): boolean

rpush

  • rpush(...args: any[]): boolean

rpushx

  • rpushx(args: any[], callback?: any): boolean
  • rpushx(...args: any[]): boolean

sadd

  • sadd(args: any[], callback?: any): boolean
  • sadd(...args: any[]): boolean

save

  • save(args: any[], callback?: any): boolean
  • save(...args: any[]): boolean

scan

  • scan(...args: any[]): boolean
  • scan(args: any[], callback?: any): boolean

scard

  • scard(args: any[], callback?: any): boolean
  • scard(...args: any[]): boolean

script

  • script(args: any[], callback?: any): boolean
  • script(...args: any[]): boolean
  • script(key: string, callback?: any): boolean

sdiff

  • sdiff(args: any[], callback?: any): boolean
  • sdiff(...args: any[]): boolean

sdiffstore

  • sdiffstore(args: any[], callback?: any): boolean
  • sdiffstore(...args: any[]): boolean

select

  • select(args: any[], callback?: any): void
  • select(...args: any[]): void

send_command

  • send_command(command: string, ...args: any[]): boolean

set

  • set(key: string, value: string, callback?: any): boolean
  • set(args: any[], callback?: any): boolean
  • set(...args: any[]): boolean

setbit

  • setbit(args: any[], callback?: any): boolean
  • setbit(...args: any[]): boolean

setex

  • setex(args: any[], callback?: any): boolean
  • setex(...args: any[]): boolean

setnx

  • setnx(args: any[], callback?: any): boolean
  • setnx(...args: any[]): boolean

setrange

  • setrange(args: any[], callback?: any): boolean
  • setrange(...args: any[]): boolean

shutdown

  • shutdown(args: any[], callback?: any): boolean
  • shutdown(...args: any[]): boolean

sinter

  • sinter(args: any[], callback?: any): boolean
  • sinter(...args: any[]): boolean

sinterstore

  • sinterstore(args: any[], callback?: any): boolean
  • sinterstore(...args: any[]): boolean

sismember

  • sismember(args: any[], callback?: any): boolean
  • sismember(...args: any[]): boolean

slaveof

  • slaveof(args: any[], callback?: any): boolean
  • slaveof(...args: any[]): boolean

smembers

  • smembers(args: any[], callback?: any): boolean
  • smembers(...args: any[]): boolean

smove

  • smove(args: any[], callback?: any): boolean
  • smove(...args: any[]): boolean

sort

  • sort(args: any[], callback?: any): boolean
  • sort(...args: any[]): boolean

spop

  • spop(args: any[], callback?: any): boolean
  • spop(...args: any[]): boolean

srandmember

  • srandmember(args: any[], callback?: any): boolean
  • srandmember(...args: any[]): boolean

srem

  • srem(args: any[], callback?: any): boolean
  • srem(...args: any[]): boolean

sscan

  • sscan(...args: any[]): boolean
  • sscan(args: any[], callback?: any): boolean

strlen

  • strlen(args: any[], callback?: any): boolean
  • strlen(...args: any[]): boolean

subscribe

  • subscribe(channel: string): boolean
  • subscribe(args: any[], callback?: any): boolean
  • subscribe(...args: any[]): boolean

substr

  • substr(args: any[], callback?: any): boolean
  • substr(...args: any[]): boolean

sunion

  • sunion(args: any[], callback?: any): boolean
  • sunion(...args: any[]): boolean

sunionstore

  • sunionstore(args: any[], callback?: any): boolean
  • sunionstore(...args: any[]): boolean

sync

  • sync(args: any[], callback?: any): boolean
  • sync(...args: any[]): boolean

ttl

  • ttl(args: any[], callback?: any): boolean
  • ttl(...args: any[]): boolean

type

  • type(args: any[], callback?: any): boolean
  • type(...args: any[]): boolean

uncork

  • uncork(): void

unref

  • unref(): void

unsubscribe

  • unsubscribe(args: any[], callback?: any): boolean
  • unsubscribe(...args: any[]): boolean

unwatch

  • unwatch(args: any[], callback?: any): boolean
  • unwatch(...args: any[]): boolean

watch

  • watch(args: any[], callback?: any): boolean
  • watch(...args: any[]): boolean

zadd

  • zadd(args: any[], callback?: any): boolean
  • zadd(...args: any[]): boolean

zcard

  • zcard(args: any[], callback?: any): boolean
  • zcard(...args: any[]): boolean

zcount

  • zcount(args: any[], callback?: any): boolean
  • zcount(...args: any[]): boolean

zincrby

  • zincrby(args: any[], callback?: any): boolean
  • zincrby(...args: any[]): boolean

zinterstore

  • zinterstore(args: any[], callback?: any): boolean
  • zinterstore(...args: any[]): boolean

zrange

  • zrange(args: any[], callback?: any): boolean
  • zrange(...args: any[]): boolean

zrangebyscore

  • zrangebyscore(args: any[], callback?: any): boolean
  • zrangebyscore(...args: any[]): boolean

zrank

  • zrank(args: any[], callback?: any): boolean
  • zrank(...args: any[]): boolean

zrem

  • zrem(args: any[], callback?: any): boolean
  • zrem(...args: any[]): boolean

zremrangebyrank

  • zremrangebyrank(args: any[], callback?: any): boolean
  • zremrangebyrank(...args: any[]): boolean

zremrangebyscore

  • zremrangebyscore(args: any[], callback?: any): boolean
  • zremrangebyscore(...args: any[]): boolean

zrevrange

  • zrevrange(args: any[], callback?: any): boolean
  • zrevrange(...args: any[]): boolean

zrevrangebyscore

  • zrevrangebyscore(args: any[], callback?: any): boolean
  • zrevrangebyscore(...args: any[]): boolean

zrevrank

  • zrevrank(args: any[], callback?: any): boolean
  • zrevrank(...args: any[]): boolean

zscan

  • zscan(...args: any[]): boolean
  • zscan(args: any[], callback?: any): boolean

zscore

  • zscore(args: any[], callback?: any): boolean
  • zscore(...args: any[]): boolean

zunionstore

  • zunionstore(args: any[], callback?: any): boolean
  • zunionstore(...args: any[]): boolean

Generated using TypeDoc