Compare commits
No commits in common. "master" and "v2.0.11" have entirely different histories.
@ -2,34 +2,17 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "webstore",
|
||||
"description": "A high-performance storage solution for web applications using IndexedDB.",
|
||||
"description": "high performance storage in the browser using indexed db",
|
||||
"npmPackagename": "@push.rocks/webstore",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"indexeddb",
|
||||
"browser storage",
|
||||
"high performance",
|
||||
"typescript",
|
||||
"database",
|
||||
"web development",
|
||||
"data persistence",
|
||||
"storage solution",
|
||||
"typed requests",
|
||||
"performance optimization",
|
||||
"API caching",
|
||||
"efficient data management"
|
||||
]
|
||||
"projectDomain": "push.rocks"
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
49
package.json
49
package.json
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "@push.rocks/webstore",
|
||||
"version": "2.0.20",
|
||||
"version": "2.0.11",
|
||||
"private": false,
|
||||
"description": "A high-performance storage solution for web applications using IndexedDB.",
|
||||
"description": "high performance storage in the browser using indexed db",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
@ -14,22 +14,22 @@
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.80",
|
||||
"@git.zone/tsbuild": "^2.1.70",
|
||||
"@git.zone/tsrun": "^1.2.46",
|
||||
"@git.zone/tstest": "^1.0.90",
|
||||
"@git.zone/tstest": "^1.0.81",
|
||||
"@push.rocks/smartntml": "^2.0.4",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^20.12.12"
|
||||
"@push.rocks/tapbundle": "^5.0.15",
|
||||
"@types/node": "^20.8.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@api.global/typedrequest-interfaces": "^3.0.19",
|
||||
"@push.rocks/lik": "^6.0.15",
|
||||
"@push.rocks/smartenv": "^5.0.12",
|
||||
"@push.rocks/smartjson": "^5.0.19",
|
||||
"@apiglobal/typedrequest-interfaces": "^2.0.1",
|
||||
"@push.rocks/lik": "^6.0.5",
|
||||
"@push.rocks/smartenv": "^5.0.5",
|
||||
"@push.rocks/smartjson": "^5.0.10",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.7",
|
||||
"@tempfix/idb": "^8.0.3",
|
||||
"fake-indexeddb": "^5.0.2"
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"fake-indexeddb": "^4.0.2",
|
||||
"idb": "^7.1.1"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
@ -45,24 +45,5 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"indexeddb",
|
||||
"browser storage",
|
||||
"high performance",
|
||||
"typescript",
|
||||
"database",
|
||||
"web development",
|
||||
"data persistence",
|
||||
"storage solution",
|
||||
"typed requests",
|
||||
"performance optimization",
|
||||
"API caching",
|
||||
"efficient data management"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/webstore",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/webstore.git"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
9311
pnpm-lock.yaml
generated
9311
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
||||
|
||||
241
readme.md
241
readme.md
@ -1,226 +1,37 @@
|
||||
# @push.rocks/webstore
|
||||
High performance storage in the browser using IndexedDB.
|
||||
high performance storage in the browser using indexed db
|
||||
|
||||
## Install
|
||||
To install `@push.rocks/webstore`, use the following npm command:
|
||||
## 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/)
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/webstore --save
|
||||
```
|
||||
## Status for master
|
||||
|
||||
This will add it to your project's dependencies.
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## 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.
|
||||
|
||||
### Basic Setup
|
||||
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:
|
||||
Use TypeScript for best in class intellisense
|
||||
|
||||
```typescript
|
||||
import { WebStore } from '@push.rocks/webstore';
|
||||
## Contribution
|
||||
|
||||
const myStore = new WebStore<{
|
||||
[key: string]: any; // Define the shape of your store objects here
|
||||
}>({
|
||||
dbName: 'myDatabase',
|
||||
storeName: 'myStore'
|
||||
});
|
||||
```
|
||||
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). :)
|
||||
|
||||
### Initialization
|
||||
To ensure that IndexedDB is set up correctly, call the `init` method before executing any CRUD operations:
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
```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', ...]
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
One of the strengths of `WebStore` is its built-in error handling using `smartpromise`. All the asynchronous operations (`init`, `get`, `set`, `delete`, `clear`, `keys`) inherently handle errors gracefully by catching them and allowing you to handle them with standard JavaScript try-catch or using `.catch` on the promises.
|
||||
|
||||
#### Error Handling Example
|
||||
In TypeScript, you can write try-catch blocks to handle errors:
|
||||
|
||||
```typescript
|
||||
try {
|
||||
await myStore.set('myKey', { some: 'data' });
|
||||
} catch (error) {
|
||||
console.error('Error storing data:', error);
|
||||
}
|
||||
|
||||
try {
|
||||
const myData = await myStore.get('myKey');
|
||||
console.log(myData);
|
||||
} catch (error) {
|
||||
console.error('Error retrieving data:', error);
|
||||
}
|
||||
```
|
||||
|
||||
### Advanced Features: 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.
|
||||
|
||||
#### Setting Up a Typed Request Cache
|
||||
To set up a `TypedrequestCache`:
|
||||
|
||||
```typescript
|
||||
import { TypedrequestCache } from '@push.rocks/webstore';
|
||||
|
||||
const myCache = new TypedrequestCache('domainIdentifier');
|
||||
```
|
||||
|
||||
#### Storing a Request and Its Response
|
||||
Store a request and its response:
|
||||
|
||||
```typescript
|
||||
await myCache.setByRequest({
|
||||
method: 'GET',
|
||||
request: 'https://example.com/api/data',
|
||||
response: { data: 'response data' }
|
||||
});
|
||||
```
|
||||
|
||||
#### Retrieving a Cached Request
|
||||
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' }
|
||||
```
|
||||
|
||||
### Comprehensive Usage Example
|
||||
Here is a comprehensive example that covers initialization, data manipulation, and error handling:
|
||||
|
||||
```typescript
|
||||
import { WebStore, TypedrequestCache } from '@push.rocks/webstore';
|
||||
|
||||
async function main() {
|
||||
const myStore = new WebStore<{
|
||||
[key: string]: any;
|
||||
}>({
|
||||
dbName: 'myDatabase',
|
||||
storeName: 'myStore',
|
||||
});
|
||||
|
||||
try {
|
||||
await myStore.init();
|
||||
|
||||
// Set data
|
||||
await myStore.set('myKey', { some: 'data' });
|
||||
console.log('Data set successfully.');
|
||||
|
||||
// Get data
|
||||
const myData = await myStore.get('myKey');
|
||||
console.log('Retrieved data:', myData); // { some: 'data' }
|
||||
|
||||
// Check data existence
|
||||
const exists = await myStore.check('myKey');
|
||||
console.log('Key exists:', exists); // true
|
||||
|
||||
// Delete data
|
||||
await myStore.delete('myKey');
|
||||
console.log('Data deleted.');
|
||||
|
||||
// Clear store
|
||||
await myStore.clear();
|
||||
console.log('Store cleared.');
|
||||
|
||||
// Fetch all keys
|
||||
const allKeys = await myStore.keys();
|
||||
console.log('All keys:', allKeys); // []
|
||||
|
||||
} catch (error) {
|
||||
console.error('Error during storage operations:', error);
|
||||
}
|
||||
|
||||
// Typed Request Caching
|
||||
const myCache = new TypedrequestCache('exampleDomain');
|
||||
|
||||
try {
|
||||
await myCache.setByRequest({
|
||||
method: 'GET',
|
||||
request: 'https://example.com/api/data',
|
||||
response: { data: 'response data' }
|
||||
});
|
||||
console.log('Typed request cached.');
|
||||
|
||||
const cachedResponse = await myCache.getByRequest({
|
||||
method: 'GET',
|
||||
request: 'https://example.com/api/data'
|
||||
});
|
||||
console.log('Cached response:', cachedResponse); // { data: 'response data' }
|
||||
} catch (error) {
|
||||
console.error('Error during typed request caching operations:', error);
|
||||
}
|
||||
}
|
||||
|
||||
main().catch(console.error);
|
||||
```
|
||||
|
||||
### Conclusion
|
||||
The `@push.rocks/webstore` package provides a flexible and efficient way to handle browser storage and caching. With features like error handling, typed request caching, and easy-to-use APIs, it can significantly improve performance and maintainability in web applications. For further exploration, feel free to explore the source code and tests provided in the repository.
|
||||
|
||||
## 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.
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
@ -41,4 +41,4 @@ tap.test('should correctly check the existence of keys', async () => {
|
||||
expect(resultThere).toBeTrue();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
tap.start();
|
||||
|
||||
@ -8,4 +8,4 @@ tap.test('first test', async () => {
|
||||
expect(testTypedrequestcache).toBeInstanceOf(webstore.TypedrequestCache);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
tap.start();
|
||||
|
||||
@ -37,4 +37,4 @@ tap.test('should correctly check the existence of keys', async () => {
|
||||
expect(resultThere).toBeTrue();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
tap.start();
|
||||
|
||||
@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/webstore',
|
||||
version: '2.0.20',
|
||||
description: 'A high-performance storage solution for web applications using IndexedDB.'
|
||||
version: '2.0.11',
|
||||
description: 'high performance storage in the browser using indexed db'
|
||||
}
|
||||
|
||||
@ -7,6 +7,7 @@ export interface IWebStoreOptions {
|
||||
|
||||
export class WebStore<T = any> {
|
||||
public db: plugins.idb.IDBPDatabase;
|
||||
public objectStore: plugins.idb.IDBPObjectStore;
|
||||
public options: IWebStoreOptions;
|
||||
private initCalled: boolean = false;
|
||||
private readyDeferred = plugins.smartpromise.defer();
|
||||
|
||||
@ -8,11 +8,11 @@ import * as smartrx from '@push.rocks/smartrx';
|
||||
export { lik, smartenv, smartjson, smartpromise, smartrx };
|
||||
|
||||
// apiglobal scope
|
||||
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
||||
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||
|
||||
export { typedrequestInterfaces };
|
||||
|
||||
// thirdparty scope
|
||||
import * as idb from '@tempfix/idb';
|
||||
import * as idb from 'idb';
|
||||
|
||||
export { idb };
|
||||
|
||||
@ -3,12 +3,9 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
"verbatimModuleSyntax": true,
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user