ngx-cookie

用于ng2+操作cookie, 相当于Angular 1.x $ cookies服务的实现, angular2-cookie的后继者

下载

1
npm install ngx-cookie --save

引入

1
import { CookieModule } from 'ngx-cookie';

方法

get()

返回对应key的value

1
2
3
4
5
/**
* @param {string} key Id to use for lookup.
* @returns {string} Raw cookie value.
*/
get(key: string): string;

getObject()

返回对应key的反序列化后的value

1
2
3
4
5
/**
* @param {string} key Id to use for lookup.
* @returns {Object} Deserialized cookie value.
*/
getObject(key: string): Object;

getAll()

返回cookie的所有键值对

1
2
3
4
/**
* @returns {Object} All cookies
*/
getAll(): any;

put()

保存给定key的value

1
2
3
4
5
6
/**
* @param {string} key Id for the `value`.
* @param {string} value Raw value to be stored.
* @param {CookieOptions} options (Optional) Options object.
*/
put(key: string, value: string, options?: CookieOptions): void;

putObject()

序列化后保存key的value

1
2
3
4
5
6
/**
* @param {string} key Id for the `value`.
* @param {Object} value Value to be stored.
* @param {CookieOptions} options (Optional) Options object.
*/
putObject(key: string, value: Object, options?: CookieOptions): void;

remove()

删除key对应的键值对

1
2
3
4
5
/**
* @param {string} key Id of the key-value pair to delete.
* @param {CookieOptions} options (Optional) Options object.
*/
remove(key: string, options?: CookieOptions): void;

removeAll()

删除所有cookies

1
removeAll(): void;