redis-tokens v0.0.2

Redis Tokens

A compact redis token manager that lets you create, fetch, update, refresh and delete tokens and their associated data

Reference

Instantiate the RedisTokens client

  import { RedisTokens } from 'redis-tokens';

  // You can pass an optional connection string here
  const redisTokens = new RedisTokens('redis://localhost:6379');

Create a token

  const token = await redisTokens.create({
    app: 'my-app',
    type: 'user-session',
    owner: 'abc',
    data: {
      something: 'here'
    },
    duration: 60 * 60 * 24 * 7
  });

Optionally pass in a manually generated token

  const myToken = myTokenGeneratorFunction();
  const token = await redisTokens.create({
    app: 'my-app',
    type: 'user-session',
    owner: 'abc',
    data: {
      something: 'here'
    },
    duration: 60 * 60 * 24 * 7,
    customToken: myToken
  });

Get a token

  const token = await redisTokens.get({
    app: 'my-app',
    type: 'user-session',
    token: 'token'
  });

Refresh a token

  await redisTokens.refresh({
    app: 'my-app',
    type: 'user-session',
    token: 'token',
    duration: 60 * 60 * 24 * 7
  });

Update a token

• Values sent as null will be deleted if they exist
• Undefined values are ignored
• Other values are inserted into the token data

  const token = await redisTokens.update({
    app: 'my-app',
    type: 'user-session',
    token: 'token',
    data: {
      insertThis: 'kaionesyan',
      deleteThis: null,
      doNothing: undefined
    }
  });

Delete a token

  await redisTokens.delete({
    app: 'my-app',
    type: 'user-session',
    token: 'token'
  });

Delete all tokens of an owner

  await redisTokens.deleteAll({
    app: 'my-app',
    type: 'user-session',
    owner: 'abc'
  });

Going Further

The native IORedis client is exposed inside the RedisTokens class, should you wish to perform other kinds of operations.

Authors

• kaionesyan

Contributing

Contributions are always welcome!