expressjs/session

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

Open

Aperta il 30 ago 2016

Vedi su GitHub
 (4 commenti) (2 reazioni) (0 assegnatari)JavaScript (6073 star) (977 fork)batch import
docshelp wanted

Descrizione

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.

Guida contributor

Tech stack
nodejsexpress
Dominio
backenddocumentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Node.js basicsExpress session middleware
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
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().