AngularJS: API: ngCookies/service/$cookieStore


$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.

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.

  • 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.

Example

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');
  }]);