ember-cookies

ember-cookies implements an abstract cookie API that works both in the browser (via document.cookie) as well as with Fastboot in the server context (using the request and response accessible via the fastBoot service).

Having access to cookies both in the browser as well as in FastBoot is key to being able to share a common session.

Note

ember-cookies was written and is maintained by Mainmatter and contributors. We offer consulting, training, and team augmentation for Ember.js – check out our website to learn more!

Installation

Install ember-cookies with

ember install ember-cookies

Example Usage

Typescript

// app/controllers/index.ts
import { inject as service } from '@ember/service';
import Controller from '@ember/controller';
import CookiesService from 'ember-cookies/services/cookies';

type Cookie = { name: string; value?: string };

export default class IndexController extends Controller {
  @service cookies!: CookiesService;

  get allCookies(): Cookie[] {
    this.cookies.write('now', new Date().getTime());

    const cookies = this.cookies.read();
    return Object.keys(cookies).reduce((acc, key) => {
      let value = cookies[key];
      acc.push({ name: key, value });

      return acc;
    }, [] as Cookie[]);
  }

  get singleCookie(): Cookie {
    const cookie = this.cookies.read('now');
    return { name: 'now', value: cookie };
  }
}

Javascript

// app/controllers/index.js
import Controller from '@ember/controller';
import { inject as service } from '@ember/service';
import { computed } from '@ember/object';

export default class ApplicationController extends Controller {
  @service cookies;

  @computed
  get allCookies () {
    let cookieService = this.cookies;
    cookieService.write('now', new Date().getTime());

    let cookies = cookieService.read();
    return Object.keys(cookies).reduce((acc, key) => {
      let value = cookies[key];
      acc.push({ name: key, value });

      return acc;
    }, []);
  }
}

API

The cookies service has methods for reading and writing cookies:

• read(name, options = {}): reads the cookie with the given name, returns its value as a String; options can be used to set raw (boolean, disables URL-decoding the value).
• write(name, value, options = {}): writes a cookie with the given name and value; options can be used to set domain, expires (Date), maxAge (time in seconds), path, secure, raw (boolean, disables URL-encoding the value) and sameSite.
• clear(name, options = {}): clears the cookie so that future reads do not return a value; options can be used to specify domain, path or secure.
• exists(name): checks whether a cookie exists at all (even with a falsy value) and returns true if that is the case or false otherwise.

Testing

ember-cookies exposes the clearAllCookies test helper that clears all known cookies to reset state before and/or after tests:

import { module, test } from 'qunit';
import { setupTest } from 'ember-qunit';
import { clearAllCookies } from 'ember-cookies/test-support';

module('Unit | Some Module', function (hooks) {
  setupTest(hooks);

  hooks.beforeEach(function () {
    clearAllCookies();
  });

  // or you may wat to clear cookies after the test run
  hooks.afterEach(function () {
    clearAllCookies();
  });
});

License

ember-cookies is developed by and © Mainmatter GmbH and contributors. It is released under the MIT License.

ember-cookies is not an official part of Ember.js and is not maintained by the Ember.js Core Team.