@types/session-file-store/index.d.ts

TypeScript definitions for session-file-store

import * as express from "express";
import * as session from "express-session";

export = f;

declare function f(options: (options?: session.SessionOptions) => express.RequestHandler): f.FileStore;

declare namespace f {
    interface FileStore {
        new(options?: Options): session.Store;
    }
    /**
     * FileStore Options
     */
    interface Options {
        /**
         * The directory where the session files will be stored. Defaults to `./sessions`
         */
        path?: string | undefined;

        /**
         * Session time to live in seconds. Defaults to `3600`
         */
        ttl?: number | undefined;

        /**
         * The number of retries to get session data from a session file. Defaults to `5`
         */
        retries?: number | undefined;

        /**
         * The exponential factor to use for retry. Defaults to `1`
         */
        factor?: number | undefined;

        /**
         * The number of milliseconds before starting the first retry. Defaults to `50`
         */
        minTimeout?: number | undefined;

        /**
         * The maximum number of milliseconds between two retries. Defaults to `100`
         */
        maxTimeout?: number | undefined;

        /**
         * [OUT] Contains intervalObject if reap was scheduled
         */
        reapIntervalObject?: any;

        /**
         * Interval to clear expired sessions in seconds or -1 if do not need. Defaults to `1 hour`
         */
        reapInterval?: number | undefined;

        /**
         * Undocumented
         */
        reapMaxConcurrent?: number | undefined;

        /**
         * Use distinct worker process for removing stale sessions. Defaults to `false`
         */
        reapAsync?: boolean | undefined;

        /**
         * Reap stale sessions synchronously if can not do it asynchronously. Default to `false`
         */
        reapSyncFallback?: boolean | undefined;

        /**
         * Log messages. Defaults to `console.log`
         */
        logFn?(...args: any[]): void;

        /**
         * Returns fallback session object after all failed retries. No defaults
         */
        fallbackSessionFn?(...args: any[]): void;

        /**
         * Object-to-text text encoding. Can be null. Defaults to `'utf8'`
         */
        encoding?: string | undefined;

        /**
         * Encoding function. Takes object, returns encoded data. Defaults to `JSON.stringify`
         */
        encoder?(...args: any[]): void;

        /**
         * Decoding function. Takes encoded data, returns object. Defaults to `JSON.parse`
         */
        decoder?(...args: any[]): void;

        /**
         * If secret string is specified then enables encryption of the session before
         * writing the file and also decryption when reading it.
         */
        secret?: string | undefined;

        /**
         * Encryption output encoding. Defaults to `'hex'`
         */
        encryptEncoding?: string | undefined;

        /**
         * File extension of saved files. Defaults to `'.json'`
         */
        fileExtension?: string | undefined;

        /**
         * Undocumented
         */
        filePattern?: RegExp | undefined;

        /**
         * Encryption key retrieval function. Takes secret andsession id, returns key.
         * Defaults to `function(secret, sessionId){return secret + sessionId;}`
         */
        keyFunction?(secret: string, sessionId: string): string;
    }
}