Skip to main content

Redis Helpers

Connection

FunctionParametersReturns
redis_connect(url, database, username, password)url: Redis URL (e.g. "redis://localhost:6379"), database (optional): 0-15 (default 0), username (optional): ACL username, password (optional): auth password(success, error) — boolean + string|nil
redis_disconnect()none(success, error) — boolean + string|nil

Connection persists across all hooks. Call redis_connect() once in on_start(). Timeout: 500ms.

Data Operations

FunctionParametersReturns
redis_get(key)key: string (required, non-empty)(value, error) — string|nil + string|nil. 100ms timeout
redis_set(key, value, ttl_seconds)key: string, value: string, ttl_seconds (optional): number (nil for no expiry)(success, error) — boolean + string|nil. 100ms timeout
redis_set_async(key, value, ttl_seconds)Same as redis_settrue if queued, false if not connected/invalid key. 1000ms timeout
redis_del(key)key: string (required, non-empty)(deleted_count, error) — number (0 or 1) + string|nil. 1000ms timeout
redis_del_async(key)key: string (required, non-empty)true if queued, false if not connected/invalid key. 100ms timeout
redis_exists(key)key: string (required, non-empty)(exists, error) — boolean + string|nil. 100ms timeout