Meta tags:
description=Use Bun s native Redis client with a Promise-based API;

Headings (most frequently used words):

operations, connection, and, started, basic, usage, system, storage, redis, documentation, index, on, this, page, getting, pub, sub, advanced, options, supported, url, formats, error, handling, example, use, cases, implementation, notes, limitations, future, plans, get, core, runtime, file, module, http, server, networking, data, concurrency, process, interop, tooling, utilities, standards, compatibility, contributing, lifecycle, string, numeric, hash, set, publishing, subscriptions, command, execution, pipelining, raw, commands, events, status, monitoring, type, conversion, reconnection, behavior, caching, rate, limiting, session,

Text of the page (most frequently used words):
redis (119), await (64), client (43), const (36), the (35), redisclient (27), set (26), connection (26), key (24), bun (23), new (21), get (20), and (18), from (18), error (17), #commands (16), with (16), user (16), localhost (15), data (13), 6379 (13), default (13), console (12), tls (12), true (12), javascript (12), exists (11), server (11), name (11), userid (10), are (10), operations (10), for (9), session (9), counter (9), unsubscribe (9), responses (9), automatically (8), returned (8), 123 (8), return (7), path (7), when (7), subscribe (7), log (7), connect (7), run (7), command (7), subscriber (7), hash (7), check (6), use (6), unix (6), socket (6), false (6), channel (6), file (6), tags (6), alice (6), greeting (6), this (5), page (5), can (5), created (5), number (5), sessionid (5), storage (5), first (5), increment (5), strings (5), close (5), send (5), method (5), listener (5), import (5), create (5), publisher (5), hello (5), member (5), documentation (4), resp3 (4), multiple (4), json (4), null (4), function (4), async (4), expire (4), count (4), limit (4), incr (4), cachekey (4), example (4), handling (4), username (4), url (4), reconnection (4), options (4), you (4), info (4), pipelining (4), boolean (4), becomes (4), connected (4), all (4), usage (4), message (4), publish (4), writer (4), basic (4), pub (4), sub (4), value (4), was (3), done (3), raw (3), limitations (3), future (3), 3600 (3), cache (3), database (3), fetch (3), cacheduser (3), connections (3), formats (3), enableofflinequeue (3), attempts (3), reconnect (3), seconds (3), pem (3), enableautopipelining (3), whether (3), disconnected (3), timeout (3), returns (3), status (3), events (3), list (3), string (3), email (3), promise (3), subscriptions (3), native (3), field (3), numeric (3), lifecycle (3), environment (3), started (3), api (3), system (3), runtime (3), built (2), workers (2), previous (2), cluster (2), multi (2), exec (2), versions (2), plans (2), protocol (2), exponential (2), backoff (2), pipelines (2), without (2), ones (2), implementation (2), notes (2), parse (2), hmget (2), stringify (2), tostring (2), hmset (2), store (2), expiration (2), windowsecs (2), ratelimit (2), rate (2), limiting (2), hour (2), not (2), try (2), caching (2), cases (2), received (2), failed (2), err_redis_authentication_failed (2), closed (2), err_redis_connection_closed (2), codes (2), else (2), authentication (2), code (2), typed (2), errors (2), over (2), rediss (2), password (2), supports (2), supported (2), executed (2), disconnection (2), maxretries (2), delay (2), behavior (2), cert (2), custom (2), pipeline (2), milliseconds (2), creating (2), watch (2), following (2), disable (2), automatic (2), sismember (2), arrays (2), array (2), bulk (2), type (2), conversion (2), monitoring (2), manually (2), disconnect (2), called (2), mylist (2), lpush (2), any (2), execution (2), advanced (2), particular (2), channels (2), publishing (2), duplicate (2), terminal (2), another (2), your (2), shell (2), general (2), 6739 (2), feedback (2), remove (2), random (2), com (2), userfields (2), fields (2), active (2), ttl (2), del (2), delete (2), explicitly (2), redis_url (2), reads (2), variables (2), process (2), getting (2), based (2), copy (2), contributing (2), node (2), compatibility (2), apis (2), toml (2), cookies (2), install (2), module (2), typescript (2), search (2), index (2), hosted, mintlify, developer, platform, powered, youtube, discord, github, next, raise, issue, suggest, edits, yes, helpful, sentinel, unsupported, features, transactions, must, through, plan, address, implemented, rust, uses, serialization, reconnects, sent, waiting, replies, getsession, hours, 86400, now, date, randomuuid, crypto, createsession, max, math, remaining, limited, exceeded, expiry, request, window, 100, getuser, getuserwithcache, invalid, response, err_redis_invalid_response, authenticate, common, unexpected, catch, non, existent, throws, different, scenarios, standard, various, during, rejected, immediately, queued, times, capped, 2000ms, starts, small, 50ms, doubles, each, attempt, lost, rejectunauthorized, alternatively, provide, config, queue, maximum, autoreconnect, 30000, idletimeout, idle, 5000, connectiontimeout, 10000, pass, configure, unpsubscribe, psubscribe, unwatch, discard, select, script, quit, auth, instead, special, specific, map, objects, booleans, throw, appropriate, simple, integer, numbers, converts, values, bufferedamount, amount, buffered, bytes, indicating, onclose, onconnect, successfully, register, handlers, lrange, range, value2, value1, including, dedicated, argument, second, arguments, option, listresult, inforesult, pipelined, improving, performance, sending, batch, processing, they, arrive, channelname, messages, baz, bar, foo, subscribing, takes, only, call, other, separate, prototype, one, everyone, experimental, expect, stable, but, still, looking, areas, improvement, provides, bindings, added, spop, poppedtag, pop, srandmember, randomtag, smembers, alltags, members, ismember, srem, sadd, add, score, hincrbyfloat, float, visits, hincrby, hget, single, directly, missing, decr, decrement, initial, time, live, expires, getbuffer, buffer, uint8array, also, control, remains, open, subsequent, initiates, made, until, handles, background, defaults, valkey_url, information, order, precedence, result, world, env, used, using, need, has, management, fully, support, license, bindgen, building, windows, benchmarking, roadmap, web, globals, standards, utils, color, semver, glob, hashing, image, htmlrewriter, jsonl, json5, markdown, yaml, secrets, csrf, protection, utilities, transpiler, compiler, ffi, interop, tooling, cron, webview, spawn, concurrency, sqlite, sql, archive, binary, streams, dns, udp, tcp, websockets, networking, metrics, routing, http, router, plugins, auto, jsx, resolution, types, bunfig, repl, debugging, mode, core, init, quickstart, installation, welcome, blog, reference, guides, test, runner, bundler, package, manager, navigation, home, skip, main, content, discover, available, pages, before, exploring, further, complete, docs, llms, txt,

Text of the page (random words):
redis bun documentation index fetch the complete documentation index at docs llms txt use this file to discover all available pages before exploring further skip to main content bun home page search k install bun search navigation data storage redis runtime package manager bundler test runner guides reference blog feedback get started welcome to bun installation quickstart typescript typescript 6 and 7 bun init bun create core runtime bun runtime watch mode debugging repl bunfig toml file module system file types module resolution jsx auto install plugins file system router http server server routing cookies tls error handling metrics networking fetch websockets tcp udp dns data storage cookies file i o streams binary data archive sql sqlite s3 redis concurrency workers process system environment variables shell spawn webview cron interop tooling node api ffi c compiler transpiler utilities csrf protection secrets console toml yaml markdown json5 jsonl htmlrewriter image hashing glob semver color utils standards compatibility globals bun apis web apis node js compatibility contributing roadmap benchmarking contributing building windows bindgen license on this page getting started connection lifecycle basic operations string operations numeric operations hash operations set operations pub sub basic usage publishing subscriptions advanced usage command execution and pipelining raw commands connection events connection status and monitoring type conversion connection options reconnection behavior supported url formats error handling example use cases caching rate limiting session storage implementation notes limitations and future plans data storage redis copy page use bun s native redis client with a promise based api copy page bun s redis client supports redis server versions 7 2 and up bun s native redis client has a promise based api with built in connection management fully typed responses and tls support redis ts import redis from bun set a key await redis set greeting hello from bun get a key const greeting await redis get greeting console log greeting hello from bun increment a counter await redis set counter 0 await redis incr counter check if a key exists const exists await redis exists greeting delete a key await redis del greeting getting started to use the redis client you first need to create a connection redis ts import redis redisclient from bun using the default client reads connection info from environment process env redis_url is used by default await redis set hello world const result await redis get hello creating a custom client const client new redisclient redis username password localhost 6379 await client set counter 0 await client incr counter by default the client reads connection information from the following environment variables in order of precedence redis_url valkey_url if not set defaults to redis localhost 6379 connection lifecycle the redis client automatically handles connections in the background redis ts no connection is made until a command is executed const client new redisclient first command initiates the connection await client set key value connection remains open for subsequent commands await client get key explicitly close the connection when done client close you can also manually control the connection lifecycle redis ts const client new redisclient explicitly connect await client connect run commands await client set key value disconnect when done client close basic operations string operations redis ts set a key await redis set user 1 name alice get a key const name await redis get user 1 name get a key as uint8array const buffer await redis getbuffer user 1 name delete a key await redis del user 1 name check if a key exists const exists await redis exists user 1 name set expiration in seconds await redis set session 123 active await redis expire session 123 3600 expires in 1 hour get time to live in seconds const ttl await redis ttl session 123 numeric operations redis ts set initial value await redis set counter 0 increment by 1 await redis incr counter decrement by 1 await redis decr counter hash operations redis ts set multiple fields in a hash await redis hmset user 123 name alice email alice example com active true get multiple fields from a hash const userfields await redis hmget user 123 name email console log userfields alice alice example com get single field from hash returns value directly null if missing const username await redis hget user 123 name console log username alice increment a numeric field in a hash await redis hincrby user 123 visits 1 increment a float field in a hash await redis hincrbyfloat user 123 score 1 5 set operations redis ts add member to set await redis sadd tags javascript remove member from set await redis srem tags javascript check if member exists in set const ismember await redis sismember tags javascript get all members of a set const alltags await redis smembers tags get a random member const randomtag await redis srandmember tags pop remove and return a random member const poppedtag await redis spop tags pub sub bun provides native bindings for the redis pub sub protocol added in bun 1 2 23 redis pub sub is experimental we expect it to be stable but we re still looking for feedback and areas for improvement basic usage create a publisher in publisher ts publisher ts import redisclient from bun const writer new redisclient redis localhost 6739 await writer connect writer publish general hello everyone writer close in another file create the subscriber in subscriber ts subscriber ts import redisclient from bun const listener new redisclient redis localhost 6739 await listener connect await listener subscribe general message channel console log received message in one shell run your subscriber terminal bun run subscriber ts and in another run your publisher terminal bun run publisher ts subscribing takes over the redisclient connection a client with subscriptions can only call redisclient prototype subscribe to send other commands to redis create a separate connection with duplicate redis ts import redisclient from bun const redis new redisclient redis localhost 6379 await redis connect const subscriber await redis duplicate await subscriber subscribe foo await redis set bar baz publishing publish messages with the publish method redis ts await client publish channelname message subscriptions subscribe to channels with the subscribe method redis ts await client subscribe channel message channel unsubscribe with the unsubscribe method redis ts await client unsubscribe unsubscribe from all channels await client unsubscribe channel unsubscribe a particular channel await client unsubscribe channel listener unsubscribe a particular listener advanced usage command execution and pipelining the client automatically pipelines commands improving performance by sending multiple commands in a batch and processing responses as they arrive redis ts commands are automatically pipelined by default const inforesult listresult await promise all redis get user 1 name redis get user 2 email to disable automatic pipelining set the enableautopipelining option to false redis ts const client new redisclient redis localhost 6379 enableautopipelining false raw commands use the send method to run any redis command including ones without a dedicated method the first argument is the command name and the second is an array of string arguments redis ts run any redis command const info await redis send info lpush to a list await redis send lpush mylist value1 value2 get list range const list await redis send lrange mylist 0 1 connection events you can register handlers for connection events redis ts const client new redisclient called when successfully connected to redis server client onconnect console log connected to redis server called when disconnected from redis server client onclose error console error disconnected from redis server error manually connect disconnect await client connect client close connection status and monitoring redis ts check if connected console log client connected boolean indicating connection status check amount of data buffered in bytes console log client bufferedamount type conversion the client automatically converts redis responses to javascript values integer responses are returned as javascript numbers bulk strings are returned as javascript strings simple strings are returned as javascript strings null bulk strings are returned as null array responses are returned as javascript arrays error responses throw javascript errors with appropriate error codes boolean responses resp3 are returned as javascript booleans map responses resp3 are returned as javascript objects set responses resp3 are returned as javascript arrays special handling for specific commands exists returns a boolean instead of a number 1 becomes true 0 becomes false sismember returns a boolean 1 becomes true 0 becomes false the following commands disable automatic pipelining auth info quit exec multi watch script select cluster discard unwatch pipeline subscribe psubscribe unsubscribe unpsubscribe connection options when creating a client you can pass options to configure the connection redis ts const client new redisclient redis localhost 6379 connection timeout in milliseconds default 10000 connectiontimeout 5000 idle timeout in milliseconds default 0 no timeout idletimeout 30000 whether to automatically reconnect on disconnection default true autoreconnect true maximum number of reconnection attempts default 20 maxretries 10 whether to queue commands when disconnected default true enableofflinequeue true whether to automatically pipeline commands default true enableautopipelining true tls options default false tls true alternatively provide custom tls config tls rejectunauthorized true ca path to ca pem cert path to cert pem key path to key pem reconnection behavior when a connection is lost the client automatically attempts to reconnect with exponential backoff the client starts with a small delay 50ms and doubles it with each attempt reconnection delay is capped at 2000ms 2 seconds the client attempts to reconnect up to maxretries times default 20 commands executed during disconnection are queued if enableofflinequeue is true default rejected immediately if enableofflinequeue is false supported url formats the redis client supports various url formats redis ts standard redis url new redisclient redis localhost 6379 new redisclient redis localhost 6379 with authentication new redisclient redis username password localhost 6379 with database number new redisclient redis localhost 6379 0 tls connections new redisclient rediss localhost 6379 new redisclient rediss localhost 6379 new redisclient redis tls localhost 6379 new redisclient redis tls localhost 6379 unix socket connections new redisclient redis unix path to socket new redisclient redis unix path to socket tls over unix socket new redisclient redis tls unix path to socket new redisclient redis tls unix path to socket error handling the redis client throws typed errors for different scenarios redis ts try await redis get non existent key catch error if error code err_redis_connection_closed console error connection to redis server was closed else if error code err_redis_authentication_failed console error authentication failed else console error unexpected error error common error codes err_redis_connection_closed connection to the server was closed err_redis_authentication_failed failed to authenticate with the server err_redis_invalid_response received an invalid response from the server example use cases caching redis ts async function getuserwithcache userid const cachekey user userid try to get from cache first const cacheduser await redis get cachekey if cacheduser return json parse cacheduser not in cache fetch from database const user await database getuser userid store in cache for 1 hour await redis set cachekey json stringify user await redis expire cachekey 3600 return user rate limiting redis ts async function ratelimit ip limit 100 windowsecs 3600 const key ratelimit ip increment counter const count await redis incr key set expiry if this is the first request in window if count 1 await redis expire key windowsecs check if limit exceeded return limited count limit remaining math max 0 limit count session storage redis ts async function createsession userid data const sessionid crypto randomuuid const key session sessionid store session with expiration await redis hmset key userid userid tostring created date now tostring data json stringify data await redis expire key 86400 24 hours return sessionid async function getsession sessionid const key session sessionid get session data const exists await redis exists key if exists return null const userid created data await redis hmget key userid created data return userid number userid created number created data json parse data implementation notes bun s redis client is implemented in rust and uses the redis serialization protocol resp3 it reconnects automatically with exponential backoff and pipelines commands so multiple commands can be sent without waiting for replies to previous ones limitations and future plans limitations we plan to address in future versions transactions multi exec must be done through raw commands unsupported features redis sentinel redis cluster was this page helpful yes no suggest edits raise issue s3 previous workers next i x github discord youtube powered by this documentation is built and hosted on mintlify a developer documentation platform