https://github.com/intevel/inspect-browser-storage
⚗️ Read and write local browser/electron storage
https://github.com/intevel/inspect-browser-storage
Last synced: 7 days ago
JSON representation
⚗️ Read and write local browser/electron storage
- Host: GitHub
- URL: https://github.com/intevel/inspect-browser-storage
- Owner: Intevel
- License: mit
- Created: 2022-10-31T18:35:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-31T22:08:17.000Z (over 3 years ago)
- Last Synced: 2025-04-02T00:41:53.784Z (about 1 year ago)
- Language: TypeScript
- Size: 80.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚗️ inspect-browser-storage
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions][github-actions-src]][github-actions-href]
> With this package you can locally and programmatically modify the LocalStorage and SessionStorage of a browser. This also applies to an Browser based Electron app.
⚠️ The default paths currently belong to chromium, other browsers will be added in the next versions. But you can set `dbPath` option for other databases. ⚠️
## Usage
Install package:
```sh
# npm
npm install inspect-browser-storage
# yarn
yarn install inspect-browser-storage
# pnpm
pnpm install inspect-browser-storage
```
Import:
```js
// ESM
import { writeToStorage, readFromStorage } from 'inspect-browser-storage'
// CommonJS
const { writeToStorage, readFromStorage } = require('inspect-browser-storage')
```
### `readFromStorage(domain, key, options?)`
**Example:**
```js
const data = await readFromStorage('test-application.de', 'auth_token')
// -> Returns the value of the key 'auth_token' in the localStorage of 'https://test-application.de/'
```
**Options:**
- `dbPath`: (string) The domain in the storage.
- `key`: (string) the key of the item in storage
- `options?`: (object) Options are defaults and get merged with the default options.
- `dbPath`: (string) Path to the database, default is the chromium path on your system
- `autoUnlink`: (boolean) If true, the package will try to unlock the database LOCK File. Default is true
- `protocol`: (string) Which protocol should be added to the domain, can be https:// or http://. Default is https://
- `storage`: (string) Define which storage it should use, can be `localStorage` or `sessionStorage`. Default is `localStorage`
### `writeToStorage(domain, key, value, options?)`
**Example:**
```js
const data = await writeToStorage('test-application.de', 'auth_token', 'eyDasdlok.......')
```
**Options:**
- `dbPath`: (string) The domain in the storage.
- `key`: (string) the key of the item in storage
- `value`: (string) the value which should set to the key in storage
- `options?`: (object) Options are defaults and get merged with the default options.
- `dbPath`: (string) Path to the database, default is the chromium path on your system
- `autoUnlink`: (boolean) If true, the package will try to unlock the database LOCK File. Default is true
- `protocol`: (string) Which protocol should be added to the domain, can be https:// or http://. Default is https://
- `storage`: (string) Define which storage it should use, can be `localStorage` or `sessionStorage`. Default is `localStorage`
## 💻 Development
- Clone this repository
- Install dependencies using `yarn install`
- Run watcher build `yarn dev`
## License
Made with 💚 by Conner Bachmann.
The idea originally comes from [Jan Bölsche](https://github.com/regular) and his package [chrome-localstorage](https://github.com/regular/chrome-localstorage/)
Published under [MIT License](./LICENSE).
[npm-version-src]: https://img.shields.io/npm/v/inspect-browser-storage?style=flat-square
[npm-version-href]: https://npmjs.com/package/inspect-browser-storage
[npm-downloads-src]: https://img.shields.io/npm/dm/inspect-browser-storage?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/inspect-browser-storage
[github-actions-src]: https://img.shields.io/github/workflow/status/Intevel/inspect-browser-storage/ci/main?style=flat-square
[github-actions-href]: https://github.com/Intevel/inspect-browser-storage/actions?query=workflow%3Aci