kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-24 13:59:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

add sessionConfig interface

Browse Source
This commit is contained in:
kerol2r20
2017-06-13 16:40:25 +08:00
committed by GitHub
parent 0bb157d4f9
commit e2a16b64b3
1 changed files with 53 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
types/koa-session/index.d.ts vendored
View File

@@ -15,59 +15,50 @@
import * as Koa from "koa";
declare function session(CONFIG: {
/**
* cookie key (default is koa:sess)
*/
key?: string,
/**
* maxAge in ms (default is 1 days)
* 'session' will result in a cookie that expires when session/browser is closed
* Warning: If a session cookie is stolen, this cookie will never expire
*/
maxAge?: number | 'session',
/**
* can overwrite or not (default true)
*/
overwrite?: boolean,
/**
* httpOnly or not (default true)
*/
httpOnly?: boolean,
/**
* signed or not (default true)
*/
signed?: boolean,
/**
* You can store the session content in external stores(redis, mongodb or other DBs)
*/
store?: session.stores,
/**
* Hook: valid session value before use it
*/
valid(...rest: any[]): void,
/**
* Hook: before save session
*/
beforeSave(...rest: any[]): void,
}, app: Koa): Koa.Middleware;
declare function session(app: Koa): Koa.Middleware;
declare module 'koa' {
interface Context {
session: session.sessionProps;
}
}
declare namespace session {
interface sessionConfig {
/**
* cookie key (default is koa:sess)
*/
key?: string,
/**
* maxAge in ms (default is 1 days)
* 'session' will result in a cookie that expires when session/browser is closed
* Warning: If a session cookie is stolen, this cookie will never expire
*/
maxAge?: number | 'session',
/**
* can overwrite or not (default true)
*/
overwrite?: boolean,
/**
* httpOnly or not (default true)
*/
httpOnly?: boolean,
/**
* signed or not (default true)
*/
signed?: boolean,
/**
* You can store the session content in external stores(redis, mongodb or other DBs)
*/
store?: session.stores,
/**
* Hook: valid session value before use it
*/
valid(...rest: any[]): void,
/**
* Hook: before save session
*/
beforeSave(...rest: any[]): void,
}
interface sessionProps {
/**
* Returns true if the session is new
@@ -104,4 +95,14 @@ declare namespace session {
}
}
declare function session(CONFIG: session.sessionConfig, app: Koa): Koa.Middleware;
declare function session(app: Koa): Koa.Middleware;
declare module 'koa' {
interface Context {
session: session.sessionProps;
}
}
export = session;