push.rocks/webstore
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update tsconfig

Browse Source
This commit is contained in:
Philipp Kunz 2024-04-14 18:42:46 +02:00
parent 394d9e8f9e
commit 09e247db1e
4 changed files with 148 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
npmextra.json
View File

@ -8,14 +8,26 @@
"description": "high performance storage in the browser using indexed db",
"npmPackagename": "@push.rocks/webstore",
"license": "MIT",
"projectDomain": "push.rocks"
"projectDomain": "push.rocks",
"keywords": [
"indexeddb",
"browser storage",
"high performance",
"typescript",
"database",
"web development",
"data persistence",
"storage solution",
"typed requests",
"performance optimization"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdocs": {
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

14
package.json
View File

@ -45,5 +45,17 @@
"cli.js",
"npmextra.json",
"readme.md"
],
"keywords": [
"indexeddb",
"browser storage",
"high performance",
"typescript",
"database",
"web development",
"data persistence",
"storage solution",
"typed requests",
"performance optimization"
]
}
}

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

145
readme.md
View File

@ -1,37 +1,132 @@
# @push.rocks/webstore
high performance storage in the browser using indexed db
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/webstore)
* [gitlab.com (source)](https://gitlab.com/push.rocks/webstore)
* [github.com (source mirror)](https://github.com/push.rocks/webstore)
* [docs (typedoc)](https://push.rocks.gitlab.io/webstore/)
## Install
To install `@push.rocks/webstore`, use the following npm command:
## Status for master
```bash
npm install @push.rocks/webstore --save
```
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/webstore/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/webstore/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/webstore)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/webstore)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/webstore)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/webstore)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/webstore)](https://lossless.cloud)
This will add it to your project's dependencies.
## Usage
The `@push.rocks/webstore` module provides a high-performance storage solution for web applications, leveraging IndexedDB. This guide demonstrates how to use `@push.rocks/webstore` to store, retrieve, check, and manage data in the browser efficiently.
Use TypeScript for best in class intellisense
### Setting Up
Before using `@push.rocks/webstore`, you must import and instantiate a `WebStore` class. Specify a database name (`dbName`) and a store name (`storeName`) in the options:
## Contribution
```typescript
import { WebStore } from '@push.rocks/webstore';
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
const myStore = new WebStore<{
[key: string]: any; // Define the shape of your store objects here
}>({
dbName: 'myDatabase',
storeName: 'myStore'
});
```
For further information read the linked docs at the top of this readme.
### Initializing the Store
To ensure the IndexedDB is set up correctly, call the `init` method before executing CRUD operations:
## Legal
> MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript
await myStore.init();
```
### Storing Data
To store data, use the `set` method with a key and value. The value can be any object adhering to the store's object shape:
```typescript
await myStore.set('myKey', { some: 'data' });
```
### Retrieving Data
To retrieve data, use the `get` method with a key. This method returns a promise that resolves to the value associated with the key, or `undefined` if the key does not exist:
```typescript
const myData = await myStore.get('myKey');
console.log(myData); // { some: 'data' }
```
### Checking Data Existence
To check whether a key exists in the store, use the `check` method:
```typescript
const exists = await myStore.check('myKey');
console.log(exists); // true or false
```
### Deleting Data
To delete a specific entry, use the `delete` method with a key:
```typescript
await myStore.delete('myKey');
```
### Clearing the Store
To remove all entries from the store, use the `clear` method:
```typescript
await myStore.clear();
```
### Fetching All Keys
To retrieve all keys from the store, use the `keys` method. It returns a promise that resolves to an array of keys:
```typescript
const allKeys = await myStore.keys();
console.log(allKeys); // ['myKey', ...]
```
### Typed Request Caching
`@push.rocks/webstore` also includes a feature for caching typed requests using the `TypedrequestCache` class. This is particularly useful for caching API requests and their responses.
To set up a `TypedrequestCache`:
```typescript
import { TypedrequestCache } from '@push.rocks/webstore';
const myCache = new TypedrequestCache('domainIdentifier');
```
Store a request and its response:
```typescript
await myCache.setByRequest({
method: 'GET',
request: 'https://example.com/api/data',
response: { data: 'response data' }
});
```
Retrieve a cached request by making a partial request:
```typescript
const cachedResponse = await myCache.getByRequest({
method: 'GET',
request: 'https://example.com/api/data'
});
console.log(cachedResponse); // { data: 'response data' }
```
`@push.rocks/webstore` provides a comprehensive API to leverage browser storage efficiently while maintaining high performance.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.