Lightweight Angular module for access to cookies
You can install angular-cookie via bower
bower install angular-cookie
Other way to install angular-cookie is to clone this repo into your project with this command
git clone git@github.com:ivpusic/angular-cookie.git
Then you need to include angular-cookie.js script into your project
<script src="/path/to/angular-cookie.min.js"></script>
or include beautified version with
<script src="/path/to/angular-cookie.js"></script>
To rebuild min.js version run
grunt build
To run example execute following commands
git clone git@github.com:ivpusic/angular-cookie.git
cd angular-cookie
npm -g install bower
npm -g install grunt
npm install
bower install
grunt
After this, go at 127.0.0.1:9001/example in your browser, and you will see running example of angular-cookie.
First you need to inject ipCookie into your angular module.
var myApp = angular.module('myApp', ['ipCookie']);
And now, for example if you want to use it from your controller
myApp.controller('cookieController', ['$scope', 'ipCookie', function($scope, ipCookie) {
// your code here
}]);
General signature of main function is
ipCookie(key, value, options);
To create a cookie use
ipCookie(key, value);
The value supports strings, numbers, booleans, arrays and objects and will be automatically serialized into the cookie.
You can also set some additional options, like number of day when a cookie expires
ipCookie(key, value, { expires: 21 });
If you want to specify a cookie path use
ipCookie(key, value, { path: '/some/path' });
To get all cookies use
ipCookie();
If you want to get a cookie with a specific key use
ipCookie(key);
If any cookie was not found, function returns undefined.
The returned value will be automatically deserialized.
And if you want to remove a cookie use
ipCookie.remove(key);
To remove a cookie on a specific path use
ipCookie.remove(key, { path: '/some/path/' });
domain: 'example.com'
The domain tells the browser to which domain the cookie should be sent. If you don't specify it, it becomes the domain of the page that sets the cookie.
path: '/'
The path gives you the chance to specify a directory where the cookie is active.
expires: 21
Each cookie has an expiry date after which it is trashed. If you don't specify the expiry date the cookie is trashed when you close the browser.
expirationUnit: 'minutes'
Allows you to set the expiration time in hours, minutes or seconds.
If this is not specified, any expiration time specified will default to days.
secure: true
The Secure attribute is meant to keep cookie communication limited to encrypted transmission, directing browsers to use cookies only via secure/encrypted connections.
- Add tests