Skip to content

Commit 3a9f4b9

Browse files
committed
Upgraded packages
1 parent 05b7ac3 commit 3a9f4b9

File tree

9 files changed

+365
-309
lines changed

9 files changed

+365
-309
lines changed

.eslintrc.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,20 @@
1717
"globals": {},
1818
"parser": "babel-eslint",
1919
"parserOptions": {
20-
"ecmaVersion": 6,
2120
"sourceType": "module",
21+
"codeFrame": true,
22+
"ecmaVersion": 6,
2223
"ecmaFeatures": {
2324
"impliedStrict": true,
2425
"experimentalObjectRestSpread": true
2526
}
2627
},
2728
"rules": {
2829
"valid-jsdoc": [1, {
29-
"requireParamDescription": false,
30+
"requireParamDescription": true,
3031
"requireReturnDescription": false,
31-
"requireReturn": false,
3232
"requireReturnType": true,
33+
"requireReturn": false,
3334
"prefer": { "returns": "return" }
3435
}],
3536
"require-jsdoc": [2, {

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ The method `setItem` has changed its signature when the storage mechanism is set
115115
#### New signature
116116

117117
```javascript
118-
setItem (key {string}, value {any}, options {object});
118+
setItem (key: string, value: any, options: object) : void
119119
```
120120

121121
#### Old signature
122122

123123
```javascript
124-
setItem (key {string}, value {any}, expires {number}, path {string});
124+
setItem (key: string, value: any, expires: number, path: string) : void
125125
```
126126

127127
---

README.md

Lines changed: 2 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ modify the values to read, write, or delete.
3636
1. [Interceptors](#interceptors)
3737
1. [API: configStorage](#configstorage)
3838
1. [API: isAvailable](#isavailable)
39-
1. [Shimming Polyfills](#polyfills)
40-
1. [Running the project](#running-the-project)
39+
1. [Polyfills](#polyfills)
4140

4241
## Installing the library
4342

@@ -591,7 +590,7 @@ polyfill some of the missing features with the following alternatives:
591590

592591
```html
593592
<!-- put this script FIRST, before all other scripts -->
594-
<script src="https://cdn.polyfill.io/v2/polyfill.min.js"></script>
593+
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=default-3.3"></script>
595594
```
596595

597596
[Polyfill.io](https://polyfill.io/v2/docs/examples) reads the `User-Agent`
@@ -612,62 +611,6 @@ Read the list of available features:
612611

613612
[&#9751; Back to Index](#content)
614613

615-
## Running the project
616-
617-
If you want to fork or build your own, you must run this project.
618-
619-
### Requirements
620-
621-
1. Git on [linux](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
622-
or [windows](https://git-for-windows.github.io/).
623-
1. [Node.js](https://nodejs.org/en/) (latest stable version v6+).<br>
624-
It is preferable install [nvm](https://github.com/creationix/nvm)
625-
(node version manager).
626-
1. [Yarn](https://yarnpkg.com/en/docs/cli/) installed as global package.
627-
628-
**NOTE**: Consider install Node Version Manager (**nvm**) to upgrade easily
629-
the Node version.<br>Go to https://github.com/creationix/nvm and check the
630-
installation process for your OS.
631-
632-
If you are running Windows, you can install [nvm-windows]. Follow every
633-
step mentioned [here][nvm-windows-install] so that **nvm** will be correctly
634-
installed to manage multiple installations of **Node** (with **npm**)
635-
on a Windows computer.
636-
637-
### Building the project
638-
639-
Clone the repository:
640-
641-
```shell
642-
$ git https://github.com/jherax/proxy-storage.git
643-
```
644-
645-
If you don't have installed `yarn` as a global package, run this command:
646-
647-
```shell
648-
$ npm install -g yarn
649-
```
650-
651-
Now `yarn` will install dependencies in [`package.json`](package.json):
652-
653-
```shell
654-
$ yarn
655-
```
656-
657-
And finally execute the webpack task:
658-
659-
```shell
660-
$ yarn run build
661-
```
662-
663-
This command will lint the code with
664-
[ESLint](http://eslint.org/docs/user-guide/getting-started)
665-
and transpile the source files from `src/` to `dist/` as an [UMD] with
666-
[Babel](https://babeljs.io/). It also generates the minified and source map
667-
files.
668-
669-
[&#9751; Back to Index](#content)
670-
671614
## Versioning
672615

673616
This projects adopts the [Semantic Versioning](http://semver.org/)
@@ -712,5 +655,3 @@ repository. See [LICENSE](LICENSE) file for more information.
712655
[CommonJS]: https://blog.risingstack.com/node-js-at-scale-module-system-commonjs-require/
713656
[ES2015 Export]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export
714657
[AMD RequireJS]: http://requirejs.org/docs/api.html#jsfiles
715-
[nvm-windows]: https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows
716-
[nvm-windows-install]: https://github.com/coreybutler/nvm-windows#installation--upgrades

0 commit comments

Comments
 (0)