carhartl / typescript-cookie

A simple, lightweight TypeScript API for handling browser cookies

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TypeScript Cookie CI Status BrowserStack Test TypeScript Style Guide Maintainability Test Coverage npm size

A simple, lightweight TypeScript API for handling cookies.

Goals/Features

πŸ‘‰πŸ‘‰ If you're viewing this at https://github.com/carhartl/typescript-cookie, you're reading the documentation for the master branch. View documentation for the latest release. πŸ‘ˆπŸ‘ˆ

Installation

NPM

$ npm i typescript-cookie

Basic Usage

Importing:

import { getCookie, setCookie } from 'typescript-cookie'

Functions not being used (that is imported) can be tree-shaken by a bundler.

Create a cookie, valid across the entire site:

setCookie('name', 'value')

Create a cookie that expires 7 days from now, valid across the entire site:

setCookie('name', 'value', { expires: 7 })

Create an expiring cookie, valid to the path of the current page:

setCookie('name', 'value', { expires: 7, path: '' })

Read cookie:

getCookie('name') // => 'value'
getCookie('nothing') // => undefined

Read all visible cookies:

getCookies() // => { name: 'value' }

Note: It is not possible to read a particular cookie by additionally passing specific cookie attributes. A cookie will only be available if it's visible from where the code is called, visibility being controlled by path and domain used when setting a cookie.

Delete cookie:

removeCookie('name')

Delete a cookie valid to the path of the current page:

setCookie('name', 'value', { path: '' })
removeCookie('name') // fail!
removeCookie('name', { path: '' }) // removed!

IMPORTANT! When deleting a cookie you must pass the exact same path and domain attributes that were used to set the cookie:

removeCookie('name', { path: '', domain: '.yourdomain.com' })

Note: Removing a nonexistent cookie neither raises an exception nor returns any value.

Encoding

This project is RFC 6265 compliant. All special characters that are not allowed in the cookie-name or cookie-value are encoded with each one's UTF-8 Hex equivalent using percent-encoding.
The only character in cookie-name or cookie-value that is allowed and still encoded is the percent % character, it is escaped in order to interpret percent input as literal.
Please note that the default encoding/decoding strategy is meant to be interoperable only between cookies that are read/written by typescript-cookie. It's possible to override the default encoding/decoding strategy.

Note: According to RFC 6265, your cookies may get deleted if they are too big or there are too many cookies in the same domain, more details here.

Cookie Attributes

expires

Define when the cookie will be removed. Value must be a number which will be interpreted as days from time of creation or a Date instance. If omitted, the cookie becomes a session cookie.

To create a cookie that expires in less than a day, you can check the FAQ on the Wiki.

Default: Cookie is removed when the user closes the browser.

Examples:

setCookie('name', 'value', { expires: 365 })
getCookie('name')
removeCookie('name')

path

A string indicating the path where the cookie is supposed to be visible.

Default: /

Examples:

setCookie('name', 'value', { path: '' })
getCookie('name')
removeCookie('name', { path: '' })

domain

A string indicating a valid domain where the cookie should be visible. The cookie will also be visible to all subdomains.

Default: Cookie is visible only to the domain or subdomain of the page where the cookie was created, except for Internet Explorer (see below).

Examples:

setCookie('name', 'value', { domain: 'subdomain.site.com' })
getCookie('name')
removeCookie('name', { domain: 'subdomain.site.com' })

secure

Either true or false, indicating if the cookie transmission requires a secure protocol (https).

Default: No secure protocol requirement.

Examples:

setCookie('name', 'value', { secure: true })
getCookie('name')
removeCookie('name')

sameSite

A string, allowing to control whether the browser is sending a cookie along with cross-site requests.

Default: not set.

Note that more recent browsers are making "Lax" the default value even without specifiying anything here.

Examples:

setCookie('name', 'value', { sameSite: 'strict' })
getCookie('name')
removeCookie('name')

Codec

Decode

All get methods that rely on a proper decoding to work, such as getCookies() and getCookie(), will run the given decoder for each cookie. The returned value will be used as the cookie value.

Example from reading one of the cookies that can only be decoded using the escape function:

import { DEFAULT_CODEC, getCookie, getCookies } from 'typescript-cookie'

document.cookie = 'escaped=%u5317'
document.cookie = 'default=%E5%8C%97'

const read: Decoder<string> = (value, name) => {
  if (name === 'escaped') {
    return unescape(value)
  }
  // Fall back to default for all other cookies
  return DEFAULT_CODEC.decodeValue(value, name)
}

getCookie('escaped', read) // => 'εŒ—'
getCookie('default', read) // => 'εŒ—'
getCookies(read) // => { escaped: 'εŒ—', default: 'εŒ—' }

Encode

Set a cookie with overriding the default encoding implementation:

import { setCookie } from 'typescript-cookie'

const write: Encoder<string> = (value) => value.toUpperCase()

setCookie('uppercased', 'foo', undefined, write) // => 'uppercased=FOO; path=/'

js-cookie compatibility

To ease migration while getting full TypeScript support there's a compat module that provides an api similar to js-cookie:

import { Cookies } from 'typescript-cookie'

Cookies.get('name')

Testing

$ npm test

Run tests continuously:

$ npm test -- --watch

Releasing

We are using release-it for automated releasing.

Start a dry run to see what would happen:

$ npm run release minor -- --dry-run

Do a real release (publishes both to npm as well as create a new release on GitHub):

$ npm run release minor

GitHub releases are created as a draft and need to be published manually! (This is so we are able to craft suitable release notes before publishing.)

Supporters

Many thanks to BrowserStack for providing unlimited browser testing free of cost.

About

A simple, lightweight TypeScript API for handling browser cookies

License:MIT License


Languages

Language:TypeScript 91.8%Language:JavaScript 7.4%Language:HTML 0.8%