npm.io
3.0.12 • Published 11 months ago

@types/koa-session-minimal

Licence
MIT
Version
3.0.12
Deps
2
Size
4 kB
Vulns
0
Weekly
0
Stars
51.4K

Installation

npm install --save @types/koa-session-minimal

Summary

This package contains type definitions for koa-session-minimal (https://github.com/longztian/koa-session-minimal).

Details

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

index.d.ts

/* =================== USAGE ===================

    import Koa = require("koa");
    import session = require("koa-session-minimal");

    const app = new Koa();
    app.use(session());

 =============================================== */

import cookies = require("cookies");
import * as Koa from "koa";

declare module "koa" {
    interface Context {
        session: any;
        sessionHandler: { regenerateId: () => void };
    }
}

declare function session(opts?: {
    /**
     * session cookie name and store key prefix. Default is 'koa:sess'
     */
    key?: string | undefined;

    /**
     * cookie options
     */
    cookie?: cookies.IOptions | { (ctx?: Koa.Context): cookies.IOptions } | undefined;

    /**
     * session store
     */
    store?: any;
}): Koa.Middleware;

declare namespace session {}
export = session;

Additional Details

Credits

These definitions were written by .