plesiecki / hardtack

An ultra-light (406 bytes) library for working with cookies in JavaScript

hardtack

An ultra-light library for working with cookies in JavaScript.

Features

• Simple API
• Ultra-light (406 bytes gzipped)
• Encoding of forbidden characters
• Use as a module or add to your browser

Example

hardtack.set('name', 'Ali', {
  path: '/',
  domain: 'gasymov.com',
  maxAge: 31536000, // one year
  samesite: 'lax'
});

hardtack.get(); // { name: 'Ali' };

hardtack.get('name'); // Ali;

hardtack.remove('name', {
  path: '/',
  domain: 'gasymov.com'
});

Table of contents

• Quick start
  • Module
    • Installation
    • Usage
  • Browser
    • Installation
    • Usage
• Methods
  • set(name: string, value: string, options)
    • options.path: string
    • options.domain: string
    • options.maxAge: number
    • options.expires: string
    • options.secure: boolean
    • options.samesite: string
  • get(name: string)
  • remove(name: string, options)

Quick start

Module

Installation

npm install hardtack

Usage

import hardtack from 'hardtack';

hardtack.set('name', 'Ali', {
  path: '/',
  domain: 'gasymov.com',
  maxAge: 31536000, // 1 year
  samesite: 'lax'
});

hardtack.get(); // { name: 'Ali' };

hardtack.get('name'); // Ali;

hardtack.remove('name', {
  path: '/',
  domain: 'gasymov.com'
});

Browser

Installation

<script src="https://cdn.jsdelivr.net/npm/hardtack@4.1.2/dist/hardtack.min.js"></script>

Usage

<script>
  hardtack.set('name', 'Ali', {
    path: '/',
    domain: 'gasymov.com',
    maxAge: 31536000, // 1 year
    samesite: 'lax'
  });

  hardtack.get(); // { name: 'Ali' };

  hardtack.get('name'); // Ali;

  hardtack.remove('name', {
    path: '/',
    domain: 'gasymov.com'
  });
</script>

Methods

set(name: string, value: string, options)

Create a cookie

options.path: string

For example: '/', '/mydir'

If not specified, defaults to the current path of the current document location.

options.domain: string

For example: example.com or subdomain.example.com

If not specified, this defaults to the host portion of the current document location. Contrary to earlier specifications, leading dots in domain names are ignored, but browsers may decline to set the cookie containing such dots. If a domain is specified, subdomains are always included.

options.maxAge: number

You can use options['max-age'], the result will be the same.

Max age in seconds. For example: 60*60*24*365 or 31536000 for a year

options.expires: string

Date in GMT format. See Date.toUTCString() for help formatting this value.

options.secure: boolean

Cookie to only be transmitted over secure protocol as https.

options.samesite: string

SameSite prevents the browser from sending this cookie along with cross-site requests. Possible values for the flag are lax or strict.

More about the options of cookies on MDN.

get(name: string)

Get cookie value

remove(name: string, options)

Remove cookie. When you delete a cookie, you must pass the same options.path and options.domain that you passed when you created the cookie.