ioredis

Index

References

• default

Classes

• Cluster
• Redis

Interfaces

• ChainableCommander
• ClusterOptions
• CommonRedisOptions
• SentinelAddress
• SentinelConnectionOptions

Type Aliases

• ClusterNode
• DNSLookupFunction
• DNSResolveSrvFunction
• NatMap
• NodeRole
• RedisKey
• RedisOptions
• RedisValue
• StandaloneConnectionOptions

Variables

• ReplyError

References

default

Renames and re-exports Redis

Type Aliases

ClusterNode

ClusterNode: string | number | { host?: string; port?: number }

DNSLookupFunction

DNSLookupFunction: ((hostname: string, callback: ((err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void)) => void)

Type declaration

• • (hostname: string, callback: ((err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void)): void

Parameters

- 

hostname: string

- 

callback: ((err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void)

  - 
    - (err: NodeJS.ErrnoException | null | undefined, address: string, family?: number): void

    - 

Parameters

      - 

err: NodeJS.ErrnoException | null | undefined

      - 

address: string

      - 

Optional family: number

Returns void

Returns void

DNSResolveSrvFunction

DNSResolveSrvFunction: ((hostname: string, callback: ((err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void)) => void)

Type declaration

• • (hostname: string, callback: ((err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void)): void

Parameters

- 

hostname: string

- 

callback: ((err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void)

  - 
    - (err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]): void

    - 

Parameters

      - 

err: NodeJS.ErrnoException | null | undefined

      - 

Optional records: SrvRecord[]

Returns void

Returns void

NatMap

NatMap: {} | NatMapFunction

NodeRole

NodeRole: "master" | "slave" | "all"

RedisKey

RedisKey: string | Buffer

RedisOptions

RedisOptions: CommonRedisOptions & SentinelConnectionOptions & StandaloneConnectionOptions

RedisValue

RedisValue: string | Buffer | number

StandaloneConnectionOptions

StandaloneConnectionOptions: Partial<TcpOptions & IpcOptions> & { disconnectTimeout?: number; tls?: ConnectionOptions }

Variables

Const ReplyError

ReplyError: any = ...

Generated using TypeDoc