@types/documentdb-session

Installation

npm install --save @types/documentdb-session

Summary

This package contains type definitions for documentdb-session (https://github.com/dwhieb/documentdb-session#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/documentdb-session.

index.d.ts

import session = require("express-session");

export = DocumentDBSession;

declare function DocumentDBSession(expressSession: typeof session): DocumentDBStoreConstructor;

interface DocumentDBStoreConstructor {
    new(options: Options): session.Store;
}

interface Options {
    /**
     * The ID of the collection where the session data should be stored.
     * If the collection does not exist, it will be created when the session store initializes.
     * The collection may contain other data, or it may be a dedicated collection just for sessions.
     *
     * @default `"sessions"`
     */
    collection?: string | undefined;

    /**
     * The ID of the database where the session data should be stored.
     * If the database does not exist, it will be creaed when the session store initializes.
     *
     * @default `"sessionstore"`
     */
    database?: string | undefined;

    /**
     * By default, `documentdb-session` sets a `"type"` attribute on each session document with a value of `"session"`,
     * to distinguish session documents from other documents in the collection.
     * If you would like a different attribute or value to be used to discriminate session documents from other documents,
     * enter that as an attribute-value pair in an object here, e.g. `{ site: "mysite.com" }` or `{ _type: "session" }`.
     *
     * @default `{ type: "session" }`
     */
    discriminator?: object | undefined;
    /**
     * The URL / hostname of your DocumentDB database account, usually of the form `https://mydbaccount.documents.azure.com:443/`.
     * You can also provide this in an environment variable, (`DOCUMENTDB_URL`) instead.
     */
    host: string;
    /**
     * The primary key for your DocumentDB account.
     * A primary key is required because `documentdb-session` may create a new database for your account, if none exists.
     * You can also provide this in an environment variable (`DOCUMENTDB_KEY`) instead.
     */
    key: string;
    /**
     * The TTL (time-to-live or expiration time) for your sessions, in seconds.
     * After this time has elapsed since the last change to the session data, the session will be deleted.
     * A session's TTL is extended each time session data is changed, restarting the timer.
     * See more on [**Configuring TTL**](https://github.com/dwhieb/documentdb-session#configuring-ttl-time-to-live-or-expiration-time).
     * *Enabling TTL is strongly recommended.*
     */
    ttl?: number | undefined;
}

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/express-session

Credits

These definitions were written by Daniel Rosenwasser.