Docs4dev
Docs
angularjs / 1.4 / api / ngcookies / service / $cookiestore.html

Improve this Doc View Source $cookieStore

  1. service in module ngCookies

Provides a key-value (string-object) storage, that is backed by session cookies. Objects put or retrieved from this storage are automatically serialized or deserialized by angular's toJson/fromJson.

Requires the ngCookies module to be installed.

Note: The $cookieStore service is deprecated. Please use the $cookies service instead.

Dependencies

Methods

  • get(key);

    Returns the value of given cookie key

    Parameters

    Param Type Details
    key string

    Id to use for lookup.

    Returns

    Object

    Deserialized cookie value, undefined if the cookie does not exist.

  • put(key, value);

    Sets a value for given cookie key

    Parameters

    Param Type Details
    key string

    Id for the value.
    value Object

    Value to be stored.

  • remove(key);

    Remove given cookie

    Parameters

    Param Type Details
    key string

    Id of the key-value pair to delete.

    		 
angular.module('cookieStoreExample', ['ngCookies'])
.controller('ExampleController', ['$cookieStore', function($cookieStore) {
  // Put cookie
  $cookieStore.put('myFavorite','oatmeal');
  // Get cookie
  var favoriteCookie = $cookieStore.get('myFavorite');
  // Removing a cookie
  $cookieStore.remove('myFavorite');
}]);

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.4.14/docs/api/ngCookies/service/$cookieStore