Skip to content

Commit fe99df4

Browse files
committed
docs(options): describes skipTouch option and add use cases
1 parent d92d935 commit fe99df4

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/express-session-etcd3.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,17 @@ export const maxTTL = 6442450
1717
*/
1818
export interface Etcd3StoreOptions extends IOptions {
1919
/**
20-
* Prefix used to record the keys of all the sessions
20+
* Prefix used to record the keys of all the sessions.
2121
*
2222
* Defaults to `sess`.
2323
*/
2424
prefix?: string
25+
/**
26+
* Option to skip touching process that express does every time it reads the session.
27+
* This is useful if you work with big TTL and wanna free your ETCD from this extra access.
28+
*
29+
* Defaults to `false`.
30+
*/
2531
skipTouch?: boolean
2632
}
2733

0 commit comments

Comments
 (0)