Add documentation for cookie-js (#8836)

This commit is contained in:
cronon
2016-04-13 00:47:10 +09:00
committed by Masahiro Wakame
parent b9642fb8ac
commit 2e81827c9e
+28 -2
View File
@@ -2,20 +2,46 @@
// Project: https://github.com/js-coder/cookie.js
// Definitions by: Boltmade <https://github.com/Boltmade>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* Shortcut for cookie.get()
*/
declare function cookie(key : string, fallback?: string) : string;
declare function cookie(keys : string[], fallback?: string) : string;
declare namespace cookie {
/**
* Create a cookie. The value will automatically be escaped.
*/
export function set(key : string, value : string, options? : any) : void;
/**
* Set several cookies at once
*/
export function set(obj : any, options? : any) : void;
/**
* Remove cookies
*/
export function remove(key : string) : void;
export function remove(keys : string[]) : void;
export function remove(...args : string[]) : void;
/**
* Remove all cookies
*/
export function empty() : void;
/**
* Retrieve the value of the cookie
*/
export function get(key : string, fallback?: string) : string;
export function get(keys : string[], fallback?: string) : string;
/**
* Retrieve values of several cookies
*/
export function get(keys : string[], fallback?: string) : any;
/**
* Get all currently saved cookies
*/
export function all() : any;
/**
* Test if cookies are enabled
*/
export function enabled() : boolean;
}