diet-cookies

1.0.0 • Public • Published

diet-cookies

Build Status Coverage Status npm

A very small, fast and simple HTTP Cookie Manager for the diet.js framework.

Install

npm install diet-cookies

Example Usage

// Create Server Instance
var server = require('diet')
var app = new server()
app.listen(8000)
 
// Register Cookie Header
var cookies = require('diet-cookies')
app.header(cookies)
 
// Register a GET route at "/"
app.get('/', function($){
    // Set cookies
    $.cookies.set('id', '1000')
    
    // Read cookies
    console.log($.cookies.id)  // -> '1000'    
    console.log($.cookies)      // -> { id: '1000' }
    
    // Delete cookies
    $.cookies.delete('id')
    
    $.end()
})

Read Cookies

Every cookie is stored in the $.cookies object.

$.cookies.your_cookie_name
$.cookies.other_cookie

Set Cookies

name and value is required, options are not.

// api
$.cookies.set(name, value, options)
// example with defaults
$.cookies.set('id', '100', {
    expire: [0,0,0,0,0],    // [days, hours, minutes, seconds, milliseconds]
    httpOnly: false,    // for http only managable cookies
    secure: false,      // for secure cookies
    path: '/',          // set cookies spcific to paths  
    domain: ''          // set cookies specific to domains
})

Delete Cookies

// api
$.cookies.delete(name)
// example
$.cookies.delete('id')

MIT Licensed

Copyright (c) 2014-2017 Halász Ádám mail@adamhalasz.com

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.

Package Sidebar

Install

npm i diet-cookies

Weekly Downloads

5

Version

1.0.0

License

MIT

Last publish

Collaborators

  • adamhalasz