client.redis.expire

Set a TTL on a RedisOS key.

Signature

class Client {
  redis: {
    expire(key: string, ttl: number): Promise<boolean>
  }
}

Name	Type	Required	Notes
`key`	string	yes	Redis key name
`ttl`	number	yes	Time-to-live in seconds

true

if the TTL was set,

false

if the key doesn't exist.

await bf.redis.expire('temp:data', 86400) // expire in 24 hours

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

Already-expired keys — setting TTL on a key that has already expired returns
```
false
```
TTL precision — TTL is specified in seconds, not milliseconds

{auto-injected}