ngx-cookie
Implementation of Angular 1.x $cookies service to Angular. Successor of angular2-cookie
Table of contents:
Get Started
Installation
You can install this package locally with npm.
# To get the latest stable version and update package.json file: npm install ngx-cookie --save# or # yarn add ngx-cookie
After installing the library, it should be included in the SystemJS configurations.
/** * System configuration for Angular samples * Adjust as necessary for your application needs. * Taken from: https://github.com/angular/quickstart/blob/master/systemjs.config.js */ { System;}this;
Usage
CookieModule
should be registered in the AppModule
with forRoot()
static method and with forChild()
in the child modules.
These methods accepts CookieOptions
objects as well. Leave it blank for the defaults.
;; ; ;
;;
Examples
Here you can find some usage examples with popular boilerplate libraries.
Angular2-quickstart
A boilerplate provided by Angular team. (Link: https://github.com/angular/quickstart)
Just edit the systemjs.config.js
file and add the ngx-cookie
there.
/** * System configuration for Angular 2 samples * Adjust as necessary for your application needs. */this;
Angular2-seed
A popular seed project. (Link: https://github.com/mgechev/angular2-seed)
Add the following settings to the (constructor of) ProjectConfig
class (path: ./tools/config/project.config.ts
).
; this.addPackagesBundlesadditionalPackages;
Do not forget to inject the CookieModule
in the module AppModule
and SharedModule
.
CookieService
There are 7 methods available in the CookieService
(6 standard methods from Angular 1 and 1 extra removeAll()
method for convenience)
get()
Returns the value of given cookie key.
/** * @param * @returns */getkey: string: string;
getObject()
Returns the deserialized value of given cookie key.
/** * @param * @returns */getObjectkey: string: Object;
getAll()
Returns a key value object with all the cookies.
/** * @returns */getAll: any;
put()
Sets a value for given cookie key.
/** * @param * @param * @param */putkey: string, value: string, options?: CookieOptions: void;
putObject()
Serializes and sets a value for given cookie key.
/** * @param * @param * @param */putObjectkey: string, value: Object, options?: CookieOptions: void;
remove()
Remove given cookie.
/** * @param * @param */removekey: string, options?: CookieOptions: void;
removeAll()
Remove all cookies.
/** */removeAll: void;
Options
Options object should be a type of CookieOptions
interface. The object may have following properties:
- path - {string} - The cookie will be available only for this path and its sub-paths. By default, this is the URL that appears in your
<base>
tag. - domain - {string} - The cookie will be available only for this domain and its sub-domains. For security reasons the user agent will not accept the cookie if the current domain is not a sub-domain of this domain or equal to it.
- expires - {string|Date} - String of the form "Wdy, DD Mon YYYY HH:MM:SS GMT" or a Date object indicating the exact date/time this cookie will expire.
- secure - {boolean} - If
true
, then the cookie will only be available through a secured connection.