client.redis.incr

Increment a RedisOS key's numeric value.

Signature

class Client {
  redis: {
    incr(key: string, opts?: { by?: number; ttl?: number }): Promise<number>
  }
}

Name	Type	Required	Notes
`key`	string	yes	Redis key name
`by`	number	no	Increment amount (default 1)
`ttl`	number	no	TTL in seconds (set on first creation)

The new value after increment.

const count = await bf.redis.incr('page:visits', { by: 1 })
console.log(`Visit #${count}`)

Error	Condition
`ApiError`	API request failed
`NetworkError`	Network issue

Non-numeric values — incrementing a key that holds a non-numeric value returns an error
Missing key — if the key doesn't exist, it's created with value 0 before incrementing

{auto-injected}