❤
npm
Sign UpSign In

tedis2
TypeScript icon, indicating that this package has built-in type declarations

0.2.3 • Public • Published

tedis logo

travis issues license package Coverage Status tag
pr release languages size commit

Supporting Tedis

Introduction

What is tedis

Tedis write with typescript, it's the client of redis for nodejs, support async with ts and commonjs

Installation

yarn add tedis2

Getting started

commonjs

const { Tedis, TedisPool } = require("tedis2");

typescript

import { Tedis, TedisPool } from "tedis2";
// no auth
const tedis = new Tedis({
  port: 6379,
  host: "127.0.0.1"
});
 
// auth
const tedis = new Tedis({
  port: 6379,
  host: "127.0.0.1",
  password: "your_password"
});

tls

const tedis = new Tedis({
  port: 6379,
  host: "127.0.0.1",
  tls: {
    key: fs.readFileSync(__dirname + "/client_server/client_key.pem"),
    cert: fs.readFileSync(__dirname + "/client_server/client_cert.pem")
  }
});

TedisPool

// no auth
const pool = new TedisPool({
  port: 6379,
  host: "127.0.0.1"
});
 
// auth
const pool = new TedisPool({
  port: 6379,
  host: "127.0.0.1",
  password: "your_password"
});
const tedis = await pool.getTedis();
// ... do some commands
pool.putTedis(tedis);

tls

const tedis = new TedisPool({
  port: 6379,
  host: "127.0.0.1",
  tls: {
    key: fs.readFileSync(__dirname + "/client_server/client_key.pem"),
    cert: fs.readFileSync(__dirname + "/client_server/client_cert.pem")
  }
});

Example

/**
 * core
 */
await tedis.command("SET", "key1", "Hello");
// "OK"
await tedis.command("SET", "key2", "World");
// "OK"
 
/**
 * key
 */
await tedis.keys("*");
// []
await tedis.exists("a");
// 0
 
/**
 * string
 */
await tedis.set("mystring", "hello");
// "OK"
await tedis.get("mystring");
// "hello"
 
/**
 * hash
 */
await tedis.hmset("myhash", {
  name: "tedis",
  age: 18
});
// "OK"
await tedis.hgetall("myhash");
// {
//   "name": "tedis",
//   "age": "18"
// }
 
/**
 * list
 */
await tedis.lpush("mylist", "hello", "a", "b", "c", "d", 1, 2, 3, 4);
// 9
await tedis.llen("mylist");
// 9

Type interface

base

pool

key

string

hash

list

set

zset

/tedis2/

    Package Sidebar

    Install

    npm i tedis2

    Repository

    github.com/silkjs/tedis

    Homepage

    github.com/silkjs/tedis#readme

    Weekly Downloads

    2

    Version

    0.2.3

    License

    MIT

    Unpacked Size

    147 kB

    Total Files

    20

    Last publish

    Collaborators

    • starzou
    Try on RunKit
    Report malware