BlueForge Docs

client.redis.get

Get a RedisOS key's value.

Signature

class Client {
  redis: {
    get(key: string): Promise<unknown>
  }
}

Parameters

NameTypeRequiredNotes
key
stringyesRedis key name

Throws

ErrorCondition
AuthError
Invalid or expired API key

Examples

const value = await bf.redis.get('session:abc123')
console.log(value) // "user_data" or whatever was stored

Pitfalls

  • Scoped to project — keys are automatically namespaced to the configured
    projectId
  • TTL-aware — returns
    null
    for expired keys (same as a missing key)

See also

{auto-injected}

Tested against

{auto-injected}