svelte-kit-connect-redis

!style

svelte-kit-connect-redis provides Redis session storage for svelte-kit-sessions.

Installation

svelte-kit-connect-redis requires svelte-kit-sessions to installed and one of the following compatible Redis clients:

- redis
- ioredis

Install with redis:

``console
$ npm install redis svelte-kit-connect-redis svelte-kit-sessions

$ yarn add redis svelte-kit-connect-redis svelte-kit-sessions

$ pnpm add redis svelte-kit-connect-redis svelte-kit-sessions
`

Install with ioredis:

`console
$ npm install ioredis svelte-kit-connect-redis svelte-kit-sessions

$ yarn add ioredis svelte-kit-connect-redis svelte-kit-sessions

$ pnpm add ioredis svelte-kit-connect-redis svelte-kit-sessions
`

Usage

svelte-kit-connect-redis can be used as a custom store for svelte-kit-sessions as follows.

Note For more information about svelte-kit-sessions, see https://www.npmjs.com/package/svelte-kit-sessions.

$3

`ts
// src/hooks.server.ts
import type { Handle } from '@sveltejs/kit';
import { sveltekitSessionHandle } from 'svelte-kit-sessions';
import RedisStore from 'svelte-kit-connect-redis';
import { createClient } from 'redis';

const client = redis.createClient({
url: 'redis://{your redis endpoint}'
});
const clientConnection = await client.connect();

export const handle: Handle = sveltekitSessionHandle({
secret: 'secret',
store: new RedisStore({ client: clientConnection })
});
`

$3

`ts
// src/hooks.server.ts
import type { Handle } from '@sveltejs/kit';
import { sveltekitSessionHandle } from 'svelte-kit-sessions';
import RedisStore from 'svelte-kit-connect-redis';
import { Redis } from 'ioredis';

const client = new Redis({
host: '{your redis host}',
port: 6379
});

export const handle: Handle = sveltekitSessionHandle({
secret: 'secret',
store: new RedisStore({ client })
});
`

API

`ts
import RedisStore from 'svelte-kit-connect-redis';

new RedisStore(options);
`

$3

Create a Redis store for svelte-kit-sessions.

$3

A summary of the options is as follows.

| Name | Type | required/optional | Description |
| ---------- | -------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| client | redis.RedisClientType \| ioredis.Redis | _required_ | An instance of redis or ioredis |
| prefix | string | _optional_ | Key prefix in Redis (default: sess:). |
| serializer | Serializer | _optional_ | Provide a custom encoder/decoder to use when storing and retrieving session data from Redis (default: JSON.parse and JSON.stringify). |
| ttl | number | _optional_ | ttl to be used if ttl is _Infinity_ when used from svelte-kit-sessions |

#### client

An instance of redis or ioredis.

#### prefix

Key prefix in Redis (default: sess:).

#### serializer

Provide a custom encoder/decoder to use when storing and retrieving session data from Redis (default: JSON.parse and JSON.stringify).

Note When setting up a custom serializer, the following interface must be satisfied.

`ts
interface Serializer {
parse(s: string): SessionStoreData | Promise;
stringify(data: SessionStoreData): string;
}
`

#### ttl

When svelte-kit-sessions calls a method of the store (the set function), ttl(milliseconds) is passed to it. However, if the cookie options expires and maxAge are not set, the ttl passed will be _Infinity_.

If the ttl passed is _Infinity_, the ttl to be set can be set with this option. The unit is milliseconds.

`ts
// svelte-kit-connect-redis implementation excerpts
const ONE_DAY_IN_SECONDS = 86400;
export default class RedisStore implements Store {
constructor(options: RedisStoreOptions) {
this.ttl = options.ttl || ONE_DAY_IN_SECONDS * 1000;
}

ttl: number;

async set(id: string, storeData: SessionStoreData, ttl: number): Promise {
// omission ...
if (ttl !== Infinity) {
// if ttl passed as argument is not Infinity, use the argument ttl as it is.
await this.client.set(key, serialized, { PX: ttl });
return;
}
// if ttl passed as argument is Infinity, use options.ttl or default.
await this.client.set(key, serialized, { PX: this.ttl });
}
}
``

License

MIT licensed