kahnvex / cookie-monster Goto Github PK

It would be more beneficial to add the secure param based on a boolean value rather than the mere existence of the property.

E.g.

if (opts.hasOwnProperty('secure') && opts.secure === true) newCookie += '; secure';

Cookies are the old-school way to store data client side. local storage and session storage, both conforming to the Storage API, are now the recommended way to store client-only data (in general).

Cookies and local/session stores all function fundamentally the same way: as key/value stores. Of course, cookies have additional properties (path, domain, secure, etc), but that's really just metadata on the key/value pair.

I would like to propose that the cookie-monster API conform to the Storage API such that switching between stores is trivial.

As the current API is only get and set, a first step could be to alias getItem to get and setItem to set. Following that, removeItem and clear methods could be added for safe removal of single items and the entire cookie string, respectively. And finally, for completeness, key and length could be added (though they are clearly low on the priority list).

I don't see any backwards compatibility issues if getItem and setItem are aliased to the current methods. Of course, if it's desired to actually deprecate get/set then it would be beneficial to have them aliased for a while with warning messages, and then remove the get/set variants in a major version bump.

More than happy to submit a couple PRs if this sounds like something that might be acceptable.

I'm still using the old version of Cookie monster in some of my projects but the version 0.2.1 is fairly outdated and non-maintained. I'd like to refactor it in a proper ES6 format and bundle it into different formats using Rollup. If you give me an ok, I'll prepare the pull request for version 1.0. Additionally, I'm also interested in maintaining the package since, well, I'm using it already and had contributed to it in the past.

Change proposal:

• Refactor to ES6
• Expose cookie-monster class instead of an instance that is implicitly initialised with global document object
• Deprecate legacy .get(), .set() and .remove() methods
• Implement .key(n) method and .length property to completely conform to localStorage API
• Add argument type checks to .getItem() and .removeItem()
• Use Rollup + Buble to build modules in all necessary formats (ESM, commonjs and universal)
• Replace Karma + Mocha + Chai bundle with Jest for testing to decrease the number of explicit development dependencies

Nothing is exported in node.js as document is undefined.

if (typeof document !== 'undefined') module.exports = exports = bake(document);