Add definitions for js-cookie 2.0

2026-09-11 11:50:54 +08:00 · 2015-06-21 21:47:34 -05:00
parent 84dfeeac37
commit 45610fcf75
2 changed files with 141 additions and 0 deletions
@@ -0,0 +1,73 @@
+// Type definitions for js-cookie v2.0
+// Project: https://github.com/js-cookie/js-cookie
+// Definitions by: Theodore Brown <https://github.com/theodorejb>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module Cookies {
+    interface CookieOptions {
+        expires?: number | Date;
+        path?: string;
+        domain?: string;
+        secure?: boolean;
+    }
+    
+    interface CookiesStatic {
+        /**
+         * Allows default cookie options to be accessed, changed, or reset
+         */
+        defaults: CookieOptions;
+        
+        /**
+         * Create a cookie
+         */
+        set(name: string, value: string | any, options?: CookieOptions): void;
+        
+        /**
+         * Read cookie
+         */
+        get(name: string): string;
+        
+        /**
+         * Read all available cookies
+         */
+        get(): {[key: string]: string};
+        
+        /**
+         * Returns the parsed representation of the string
+         * stored in the cookie according to JSON.parse
+         */
+        getJSON(name: string): any;
+        
+        /**
+         * Returns the parsed representation of
+         * all cookies according to JSON.parse
+         */
+        getJSON(): {[key: string]: any};
+        
+        /**
+         * Delete cookie
+         */
+        remove(name: string, options?: CookieOptions): void;
+        
+        /**
+         * If there is any danger of a conflict with the namespace Cookies,
+         * the noConflict method will allow you to define a new namespace
+         * and preserve the original one. This is especially useful when
+         * running the script on third party sites e.g. as part of a widget
+         * or SDK. Note: The noConflict method is not necessary when using
+         * AMD or CommonJS, thus it is not exposed in those environments.
+         */
+        noConflict(): CookiesStatic;
+        
+        /**
+         * Create a new instance of the api that overrides the default
+         * decoding implementation. All methods that rely in a proper
+         * decoding to work, such as Cookies.remove() and Cookies.get(),
+         * will run the converter first for each cookie. The returned
+         * string will be used as the cookie value.
+         */
+        withConverter(converter: (value: string, name: string) => string): CookiesStatic;
+    }
+}
+
+declare var Cookies: Cookies.CookiesStatic;