browser-cookie - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

package.json

 {
   "name": "browser-cookie",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Standalone cookie class for the browser.",
@@ -10,3 +10,3 @@ "author": "muji <[e-mail]>",
   },
-  "dependencies": {},
+  "main": "lib/cookie.js",
   "devDependencies": {
@@ -65,2 +65,3 @@ "brfs": "~1.4.0",
           "install.md",
+          "api.md",
           "developer.md",
@@ -67,0 +68,0 @@ "license.md"

README.md

@@ -6,2 +6,9 @@ Table of Contents
   * [Install](#install)
+  * [Cookie](#cookie-1)
+    * [Options](#options)
+    * [Methods](#methods)
+      * [cookie.set(key, value, [options])](#cookiesetkey-value-options)
+      * [cookie.get(key, [value])](#cookiegetkey-value)
+      * [cookie.del(key)](#cookiedelkey)
+      * [cookie.clear(except, [options])](#cookieclearexcept-options)
   * [Developer](#developer)
@@ -31,2 +38,33 @@ * [Test](#test)
 
+## Cookie
+
+The `Cookie` class exposes the ability to get, set and delete cookie values.
+
+### Options
+
+* `raw` - Do not URI encode the cookie value.
+* `json` - Store the cookie value as JSON.
+* `expires` - Define lifetime of the cookie in days, default is 30.
+* `path` - Define the path where the cookie is valid, default is /.
+* `domain` - Define the domain whether the cookie is valid.
+* `secure` - If true, the cookie transmission requires a secure protocol (https).
+
+### Methods
+
+#### cookie.set(key, value, [options])
+
+Sets a cookie value.
+
+#### cookie.get(key, [value])
+
+Gets a cookie value. If the `value` parameter is specified it should be a conversion function, if no key is specified an object containing all key value pairs is returned.
+
+#### cookie.del(key)
+
+Deletes a cookie value.
+
+#### cookie.clear(except, [options])
+
+Clear all cookies except the keys listed in the `except` array.
+
 ## Developer
@@ -33,0 +71,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10763

increased by12.52%

Number of lines in readme file

152

increased by33.33%

Worsened metrics

Number of package files

5

decreased by-16.67%

Lines of code

164

decreased by-0.61%

No dependency changes