JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 77524
  • Score
    100M100P100Q168959F
  • License MIT

Cookie helper functions

Package Exports

  • @analytics/cookie-utils
  • @analytics/cookie-utils/lib/analytics-util-cookie.browser.cjs.js
  • @analytics/cookie-utils/lib/analytics-util-cookie.browser.es.js
  • @analytics/cookie-utils/lib/analytics-util-cookie.cjs.js
  • @analytics/cookie-utils/lib/analytics-util-cookie.es.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@analytics/cookie-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cookie Utilities

Tiny cookie utilities library for analytics & whatever else 🌈

Exposes getCookie, setCookie, removeCookie, & hasCookieSupport functions.

This will work with analytics or as a standalone import in your code.

How to install

Install @analytics/cookie-utils from npm.

npm install @analytics/cookie-utils

API

Below is the api for @analytics/cookie-utils. These utilities are tree-shakable.

getCookie

Get a cookie value.

import { getCookie } from '@analytics/cookie-utils'

const value = getCookie('cookie-key')

setCookie

Set a cookie value.

import { setCookie } from '@analytics/cookie-utils'

/* simple set */
setCookie('test', 'a')

/* complex set - cookie(name, value, ttl, path, domain, secure) */
setCookie('test', 'a', 60*60*24, '/api', '*.example.com', true)

deleteCookie

Delete a cookie.

import { deleteCookie } from '@analytics/cookie-utils'

deleteCookie('cookie-key')

hasCookieSupport

Check if cookies are supported. Will verify browser will accept cookies

import { hasCookieSupport } from '@analytics/cookie-utils'

if (hasCookieSupport()) {
  // Use them 🍪
}