session-ws v1.1.2

Session-Ws

this module is used to maintain a session with the user

ATTENTION: The module is currently in beta

Installation

Use npm to install

npm install session-ws

Usage

Require the module

const s=require('session-ws');

also request the cookie-parser module

const cookieParser = require('cookie-parser')
app.use(cookieParser("secret"));

Config

If you want you can edit the default config

Default config

config = {
    "auto-create": false,
    "signed-cookie": true
}

Use the configJson() function

s.configJson({"auto-create":true});

Syntax

Each method returns the result of the operation or its outcome

Session

New Session

When you need to create a new session for a user, you need to call the new () method and pass it the express response

app.get('/g', (req, res)=>{
    s.new(res);
    res.send("ok");
});

The method creates an id and saves it in a cookie, when you send a response to the client, the cookie will be attached to the response

Insert Data

To insert data into a user's session you can use the addOne() and addJson() methods The addOne() method adds only one data, while addJson() adds more data via a Json object

In the id slot you can pass both a string containing the session id and the request for express (the method will independently retrieve the session id from the cookie)

addOne()

app.get('/insert', (req, res)=>{
    s.add(req, "email", "email@example.com");
});

addJson()

app.get('/insert', (req, res)=>{
    let obj={
        "email":"email@example.com"
    }
    s.addJson(req, obj);
});

Get data

To get a value saved in the session you can use the get () and getOne () methods, both return an object

In the id slot you can pass both a string containing the session id and the request for express (the method will independently retrieve the session id from the cookie)

get()

app.get('/get', (req, res)=>{
    let result = s.get(req);
    console.log(result);
});

The result of the get() method will be an object containing all the data

getOne()

app.get('/getOne', (req, res)=>{
    s.getOne(req, "email");
});

The result of the getOne() method will be the requested data / object In this case the value belonging to the user will be returned, linked to the "email" key

Remove data

To remove data from the session you can use the removeKey() and cleanValue() methods The removeKey () method completely eliminates the value and its key. The cleanValue () method only deletes the value and sets it to undefined

removeKey()

app.get('/removeKey', (req, res)=>{
    s.removeKey(req, "email");
});

cleanValue()

app.get('/cleanValue', (req, res)=>{
    s.cleanValue(req, "email");
});