https://github.com/runrioter/laravel-session
:couple: Session middleware to make koa and laravel cooperate with each other
https://github.com/runrioter/laravel-session
koajs laravel-session nodejs session-middleware
Last synced: 3 months ago
JSON representation
:couple: Session middleware to make koa and laravel cooperate with each other
- Host: GitHub
- URL: https://github.com/runrioter/laravel-session
- Owner: Runrioter
- License: mit
- Created: 2017-08-27T04:12:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-29T15:11:15.000Z (about 7 years ago)
- Last Synced: 2025-03-21T22:14:57.307Z (3 months ago)
- Topics: koajs, laravel-session, nodejs, session-middleware
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laravel-session
:couple: A session middleware to make koa and laravel cooperate with each other.
In order to migrate Laravel(PHP) to Koa(Nodejs) gradually, the most main task is to make Laravel share session management with Koa, so this repository occurs.
[](https://www.npmjs.com/package/laravel-session)
[](https://travis-ci.org/Runrioter/laravel-session)
[](https://codecov.io/github/Runrioter/laravel-session?branch=master)
[](https://david-dm.org/Runrioter/laravel-session)
[](https://snyk.io/test/npm/Runrioter/laravel-session)
[](https://www.npmjs.com/package/Runrioter/laravel-session)
## Install
`npm i -S laravel-session`
## Options
- `key` - used as session cookie key
- `store` - a store used to store session. e.g. `koa-redis`, `killara-memcached`
- `expire_on_close` - `true`: when browser closed, session expires, `false`: session expires according `lifetime`
- `lifetime` session lifetime
- `cipherKey` a cipherkey used encode/decode internal session key
- `cipherAlgorithm` a algorithm used in concert with `cipherKey` that encode/decode internal session key
- `prefix` distinguish keys in order to use session store more reasonable
## Example
```javascript
'use strict';
const Koa = require('koa');
const session = require('laravel-session');
const MemcachedStore = require('killara-memcached');
const phpserialize = require('php-serialize');
const app = new Koa();
const CONFIG = {
key: 'hexindai-session', // cookie key
store: new MemcachedStore({
serialize: phpserialize.serialize,
unserialize: phpserialize.unserialize,
}),
expire_on_close: false,
lifetime: 30, // minites, the same as maxAge
cipherKey: 'base64:PmneUUljyYy+Ynyv9HCIjPvMicZoamVpnSUsf2RtKsE=',
cipherAlgorithm: 'AES-256-CBC',
prefix: 'laravel:',
};
app.use(session(app, CONFIG));
app.use(ctx => {
// demo ignore favicon
if (ctx.path === '/favicon.ico') return;
let n = ctx.session.hits || 0;
ctx.session.hits = ++n;
ctx.body = n + ' hits';
});
app.listen(3000);
console.log('listening on port 3000');
```
## LICENSE
MIT License
Copyright (c) 2017 Runrioter
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.