expressjs/session

update Readme to include details on extending Store implementation from store.js

Open

#349 建立於 2016年8月30日

在 GitHub 查看
 (4 留言) (2 反應) (0 負責人)JavaScript (6,073 star) (977 fork)batch import
docshelp wanted

描述

As noted in a comment on #97, developers who want to write a Store implementation either need to:

  1. extend their Store from express-session's store.js, which typically means requiring express-session as a dependency
  2. implement their own version of the functionality in store.js, session.js, and cookie.js (or copy the files from express-session)

This is because express-session requires the following methods on the Store in order to work:

  • regenerate()
  • load()
  • createSession()

These are available in store.js, but createSession itself requires both session.js and cookie.js.

The documentation should be updated to provide guidance on these facts.

貢獻者指南

技術棧
nodejsexpress
領域
backenddocumentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Node.js basicsExpress session middleware
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Update the README to explain that developers implementing a custom Store must either extend from store.js (which requires express session as a dependency) or replicate methods from store.js, session.js, and cookie.js. Refer to the comment on issue #97 for context. The documentation should specify that three methods are required: regenerate(), load(), and createSession().