NGX Cookie Service
An (AOT ready) Angular (4.2+) service for cookies. Originally based on the ng2-cookies library.
npm install ngx-cookie-service --save# oryarn add ngx-cookie-service
Add the cookie service to your
app.module.ts as a provider:
Then, import and inject it into a component:
What to do now?
npm run testto run the tests for the cookie service (located in the
- Have a look at and play around with the
demo-appto get to know the cookie service with
npm run start(open
http://localhost:4200/in your favourite browser)
- If you do not want to install this via NPM, you can run
npm run compileand use the
*.jsfiles in the
check( name: string ): boolean;
Checks if a cookie with the given
name can be accessed or found.
get( name: string ): string;
Gets the value of the cookie with the specified
Returns a map of key-value pairs for cookies that can be accessed.
set( name: string, value: string, expires?: number | Date, path?: string, domain?: string, secure?: boolean, sameSite?: 'Lax' | 'Strict' ): void;
cookieService.set 'test', 'Hello World' ;
Sets a cookie with the specified
value. It is good practice to specify a path. If you are unsure about the path value, use
'/'. If no path or domain is explicitly defined, the current location is assumed.
delete( name: string, path?: string, domain?: string ): void;
Deletes a cookie with the specified
name. It is best practice to always define a path. If you are unsure about the path value, use
deleteAll( path?: string, domain?: string ): void;
Deletes all cookies that can currently be accessed. It is best practice to always define a path. If you are unsure about the path value, use
Checking out the following resources usually solves most of the problems people seem to have with this cookie service:
- article about cookies in general @MDN (recommended read!)
- common localhost problems @StackOverflow
- problems with secure cookies @StackOverflow
- how do browser cookie domains work? @StackOverflow
- get cookies from different paths
The following general steps are usually very helpful when debugging problems with this cookie service or cookies in general:
- check out if there are any open or closed issues that answer your question
- check out the actual value(s) of
- does it work if you use
document.cookiemanually (i.e. in a console of your choice)?
- set explicit paths for your cookies
- explain to your local rubber duck why your code should work and why it (probably) does not
I am always getting a "token missing" or "no provider" error.
Package managers are a well known source of frustration. If you have "token missing" or "no provider" errors, a simple re-installation of your node modules might suffice:
rm -rf node_modules yarn # or `npm install`
I have a problem with framework X or library Y. What can I do?
Please be aware that we cannot help you with problems that are out of scope. For example, we cannot debug a Symfony or Springboot application for you. In that case, you are better off asking the nice folks over at StackOverflow for help.
Do you support Angular Universal?
Please make sure to check out our FAQ before you open a new issue. Also, try to give us as much information as you can when you open an issue. Maybe you can even supply a test environment or test cases, if necessary?
We are happy to accept pull requests or test cases for things that do not work. Feel free to submit one of those.
However, we will only accept pull requests that pass all tests and include some new ones (as long as it makes sense to add them, of course).
This cookie service is brought to you by 7leads GmbH. We built it for one of our apps, because the other cookie packages we found were either not designed "the Angular way" or caused trouble during AOT compilation.
Thanks to all contributors: