https://github.com/naver/egjs-persist
Provide cache interface to handle persisted data among history navigation.
https://github.com/naver/egjs-persist
bfcache cache egjs persist storage
Last synced: 6 months ago
JSON representation
Provide cache interface to handle persisted data among history navigation.
- Host: GitHub
- URL: https://github.com/naver/egjs-persist
- Owner: naver
- License: mit
- Created: 2017-04-27T06:43:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T13:50:30.000Z (over 2 years ago)
- Last Synced: 2024-04-14T08:30:24.209Z (over 1 year ago)
- Topics: bfcache, cache, egjs, persist, storage
- Language: JavaScript
- Homepage: https://naver.github.io/egjs-persist/
- Size: 1.61 MB
- Stars: 42
- Watchers: 16
- Forks: 10
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# egjs-persist [](https://badge.fury.io/js/%40egjs%2Fpersist) [](https://travis-ci.org/naver/egjs-persist) [](https://coveralls.io/github/naver/egjs-persist?branch=master)
Provide cache interface to handle persisted data among history navigation.
## Documents
- [Get Started and Demos](https://naver.github.io/egjs-persist/)
- [API documentation](https://naver.github.io/egjs-persist/release/latest/doc/)
## Download and Installation
Download dist files from repo directly or install it via npm.
### For development (Uncompressed)
You can download the uncompressed files for development
- Latest : https://naver.github.io/egjs-persist/release/latest/dist/persist.js
- Specific version : https://naver.github.io/egjs-persist/release/[VERSION]/dist/persist.js
### For production (Compressed)
You can download the compressed files for production
- Latest : https://naver.github.io/egjs-persist/release/latest/dist/persist.min.js
- Specific version : https://naver.github.io/egjs-persist/release/[VERSION]/dist/persist.min.js
### Installation with npm
The following command shows how to install egjs-persist using npm.
```bash
$ npm install @egjs/persist
```
## How to use
```js
import Persist from "@egjs/persist";
const persist = new Persist(key);
// Get information about that page.
const aInfo = persist.get("a");
// Set information about that page.
persist.set("a", "aa");
// Remove information about that page.
persist.remove("a");
```
### Handle the error
If the information stored in Persist exceeds the storage quota, a `PersistQuotaExceededError` error occurs.
The template of the error message is as follows.
```
Uncaught PersistQuotaExceededError: Setting the value (size: 000) of 'Key' exceeded the SessionStorage's quota. The highest values of SessionStorage are {"key0":0}, {"key1":0}, {"key2":0}.
```
If you handle the error, you can check the storage information, the key you want to save, and the size of the information.
```js
import Persist, { PersistQuotaExceededError } from "@egjs/persist";
const persist = new Persist(key);
try {
// Get information about that page.
const aInfo = persist.get("a");
// Set information about that page.
persist.set("a", "aa");
// Remove information about that page.
persist.remove("a");
} catch (e) {
if (e instanceof PersistQuotaExceededError) {
console.log(e.key, e.size);
}
}
```
### Used in SPA
We cannot detect changes in history. The entity using the SPA must respond to changes.
#### Vanilla
```js
import { updateDepth, replaceDepth } from "@egjs/persist";
// use pushState function
const orgPushState = history.pushState;
Object.defineProperty(history, "pushState", {
configurable: true,
value: (...args) => {
orgPushState.call(history, ...args);
updateDepth();
},
});
// or
history.pushState("/aa", "title", {});
updateDepth();
// use replaceState function
const orgReplaceState = history.replaceState;
Object.defineProperty(history, "replaceState", {
configurable: true,
value: (...args) => {
orgReplaceState.call(history, ...args);
replaceState();
},
});
// or
history.replaceState("/aa", "title", {});
replaceDepth();
```
#### React
```jsx
import React, { useEffect } from "react";
import { Router } from "react-router-dom";
import { createBrowserHistory } from "history";
import { updateDepth } from "@egjs/persist";
const customHistory = createBrowserHistory();
export default function App() {
useEffect(() => customHistory.listen(() => {
updateDepth();
}), []);
return (
...
);
}
```
#### Vue
```js
import VueRouter from "vue-router";
import { updateDepth } from "@egjs/persist";
const router = new VueRouter();
router.afterEach(() => {
updateDepth();
});
```
## Supported Browsers
The following are the supported browsers.
|Internet Explorer|Chrome|Firefox|Safari|iOS|Android|
|---|---|---|---|---|---|
|9+|latest|latest|latest|7+|2.3+ (except 3.x)|
## How to start developing egjs-persist?
For anyone interested to develop egjs-persist, follow the instructions below.
### Development Environment
#### 1. Clone the repository
Clone the egjs-persist repository and install the dependency modules.
```bash
# Clone the repository.
$ git clone https://github.com/naver/egjs-persist.git
```
#### 2. Install dependencies
`npm` is supported.
```
# Install the dependency modules.
$ npm install
```
#### 3. Build
Use npm script to build eg.Persist
```bash
# Run webpack-dev-server for development
$ npm start
# Build
$ npm run build
# Generate jsdoc
$ npm run jsdoc
```
Two folders will be created after complete build is completed.
- **dist** folder: Includes the **persist.js** and **persist.min.js** files.
- **doc** folder: Includes API documentation. The home page for the documentation is **doc/index.html**.
### Linting
To keep the same code style, we adopted [ESLint](http://eslint.org/) to maintain our code quality. The [rules](https://github.com/naver/eslint-config-naver/tree/master/rules) are modified version based on [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
Setup your editor for check or run below command for linting.
```bash
$ npm run lint
```
### Test
Once you created a branch and done with development, you must perform a test running `npm run test` command before you push code to a remote repository.
```bash
$ npm run test
```
Running a `npm run test` command will start [Mocha](https://mochajs.org/) tests via [Karma-runner](https://karma-runner.github.io/).
## Bug Report
If you find a bug, please report it to us using the [Issues](https://github.com/naver/egjs-persist/issues) page on GitHub.
## License
egjs-persist is released under the [MIT license](http://naver.github.io/egjs/license.txt).
```
Copyright (c) 2015 NAVER Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```