Skip to main content
Deno 2 is finally here 🎉️
Learn more

Functional Redis

A simple Redis client in tune with Functional Programming principles in JavaScript for Deno.

deno land deno version GitHub release GitHub licence

Redis Request

The RedisRequest represents a Redis request. It has three attributes: the first is the Redis command, the second is a typed array named “raw”, the last is an array of arguments. The RedisRequest type is mostly interoperable with Resource, File, (HTTP) Request and (HTTP) Response.

The RedisRequest type implements the following algebras:

  • Group
  • Comonad
  • Monad

Example

const redisRequest = RedisRequest("GET", new Uint8Array([]), [ "hoge" ]);

assert(RedisRequest.is(redisRequest));

A Symbol named rawPlaceholder may be used as a placeholder for the buffer. In the following example, the request will resolve to: SET hoge piyo.

import { encodeText } from "https://deno.land/x/functional@v1.1.0/library/utilities.js";
import { $$rawPlaceholder } from "https://deno.land/x/functional-redis@v0.1.0/library/Symbol.js";

const redisRequest = RedisRequest("SET", encodeText("piyo"), [ "hoge", $$rawPlaceholder ]);

assert(RedisRequest.is(redisRequest));

The placeholder can be used multiple times if the buffer has multiple values separated by CLRF (\r\n).

import { encodeText } from "https://deno.land/x/functional@v1.1.0/library/utilities.js";
import { $$rawPlaceholder } from "https://deno.land/x/functional-redis@v0.1.0/library/Symbol.js";

const redisRequest = RedisRequest(
  "MSET",
  encodeText("piyo\r\nfuga"),
  [ "hoge", $$rawPlaceholder, "hogefuga", $$rawPlaceholder ]
);

assert(RedisRequest.is(redisRequest));

Utilities

The RedisRequest namespace comes with methods for convenience to create an instance of RedisRequest with various commands. The methods are curried.

RedisRequest.append 📕

RedisRequest ~> append :: String -> String|Uint8Array -> RedisRequest

RedisRequest.bitcount 📕

RedisRequest ~> bitcount :: String -> Number[] -> RedisRequest

RedisRequest.bitop 📕

RedisRequest ~> bitop :: String -> String -> String[] -> RedisRequest

RedisRequest.bitpos 📕

RedisRequest ~> bitpos :: String -> Number[] -> RedisRequest

RedisRequest.decr 📕

RedisRequest ~> decr :: String -> RedisRequest

RedisRequest.decrby 📕

RedisRequest ~> decrby :: String -> Number -> RedisRequest

RedisRequest.get 📕

RedisRequest ~> get :: String -> RedisRequest

RedisRequest.getbit 📕

RedisRequest ~> getbit :: String -> Number -> RedisRequest

RedisRequest.getrange 📕

RedisRequest ~> getrange :: String -> Number[] -> RedisRequest

RedisRequest.getset 📕

RedisRequest ~> getset :: String -> String|Uint8Array -> RedisRequest

RedisRequest.incr 📕

RedisRequest ~> incr :: String -> RedisRequest

RedisRequest.incrby 📕

RedisRequest ~> incrby :: String -> Number -> RedisRequest

RedisRequest.incrbyfloat 📕

RedisRequest ~> incrbyfloat :: String -> Number -> RedisRequest

RedisRequest.mget 📕

RedisRequest ~> mget :: (...String) -> RedisRequest

RedisRequest.mset 📕

RedisRequest ~> mset :: String[] -> [Uint8Array ->] RedisRequest

RedisRequest.msetnx 📕

RedisRequest ~> msetnx :: String[] -> [Uint8Array ->] RedisRequest

RedisRequest.psetex 📕

RedisRequest ~> psetex :: Number -> String -> String|Uint8Array -> RedisRequest

RedisRequest.set 📕

RedisRequest ~> set :: String -> String|Uin8Array -> RedisRequest

RedisRequest.setbit 📕

RedisRequest ~> setbit :: String -> Number -> String|Uin8Array -> RedisRequest

RedisRequest.setex 📕

RedisRequest ~> setex :: Number -> String -> String|Uint8Array -> RedisRequest

RedisRequest.setnx 📕

RedisRequest ~> setnx :: String -> String|Uint8Array -> RedisRequest

RedisRequest.setrange 📕

RedisRequest ~> setrange :: String -> Number -> String|Uint8Array -> RedisRequest

RedisRequest.stralgo 📕

RedisRequest ~> stralgo :: String[] -> RedisRequest

RedisRequest.strlen 📕

RedisRequest ~> strlen :: String -> RedisRequest