wweb
wweb synchronizes Web APIs across the server and browser so you can stop writing environment conscious code and focus on building features. wweb exposes the same interfaces around Web APIs location.search -> wweb.search
, localStorage -> wweb.localStorage
, and document.cookie -> wweb.cookie
so you can use them like they were key value stores. wweb assumes that your browser or your users' browsers have web APIs. Finally, wweb supports node all the way back to 6.4.0.
Installation
$ npm install wweb
Usage
const wweb = wweb// redirects to myawesomewebsite.com, same as window.location = '...' console// => '?foo=bar' const myQueryParam = wwebsearch// => 'bar' const search = wwebsearch// => { foo: 'bar' } wwebsearchconsole// => '' wwebsearchwwebsearchconsole// => '?foo=bar&baz=qux' wwebsearchconsole// => '?quux=quuz' wwebsearchclearconsole// => '' console// => 'foo=bar; baz=qux' const myCookie = wwebcookies// => 'bar' const cookies = wwebcookies// => { foo: 'bar', baz: 'qux' } wwebcookiesconsole// => 'baz=qux' wwebcookiesconsole// => 'foo=bar; baz=qux' wwebcookiesconsole// => 'quux=quuz' wwebcookiesclearconsole// => '' wweblocalStorageconsole// => { foo: 'bar' } wweblocalStorage// => 'bar' wweblocalStorageconsole// => { foo: 'bar', quux: 'quuz' } wweblocalStorageconsole// => { foo: 'bar' } wweblocalStorageclearconsole// => {}
API
wweb.redirect(url)
Redirects you to url. Same thing as using window.location = url
Example:
wweb
wweb.search.get(name)
Gets a search parameter by name from the search query in the browser or req.query in the server. Returns null if parameter not found
Example:
const foo = wwebsearch
wweb.search.getAll(name)
Gets all search parameters in the form of an object.
Example:
const searchObj = wwebsearch
wweb.search.set(name, value)
Adds or updates a search parameter
Example:
wwebsearch
wweb.search.update(obj)
Updates entire search to represent obj
Example:
wwebsearch
wweb.search.clear()
Clears the search query
Example:
wwebsearchclear
wweb.cookie.get(name)
Gets a cookie by name from the document or req.cookies in the server. Returns null if parameter not found
Example:
const foo = wwebcookie
wweb.cookie.getAll(name)
Gets all cookie names and their values in the form of an object
Example:
const cookieObj = wwebcookie
wweb.cookie.set(name, value, opts)
Adds or updates a cookie. opts
Example:
wwebcookie
wweb.cookie.update(obj)
Updates all cookies in document to represent obj. There is no support for options for this at the moment
Example:
wwebcookie
wweb.cookie.clear()
Clears all cookies in document
Example:
wwebcookieclear
wweb.localStorage.get(name)
Gets an item by name in localStorage. Returns null if not found
Example:
const foo = wweblocalStorage
wweb.localStorage.getAll(name)
Gets all items in localStorage in the form of an object
Example:
const store = wweblocalStorage
wweb.localStorage.set(name, value)
Adds or updates an item in localStorage
Example:
wweblocalStorage
wweb.localStorage.update(obj)
Updates all items in localStorage to represent obj
Example:
wweblocalStorage
wweb.localStorage.clear()
Clears all items in localStorage
Example:
wweblocalStorageclear
Notes
Don't see your favorite web storage mechanism? Raise an issue
License
wweb © richytong