https://github.com/onadrog/idbapi
A simple implementation of IndexedDB api.
https://github.com/onadrog/idbapi
indexeddb typescrit
Last synced: about 2 months ago
JSON representation
A simple implementation of IndexedDB api.
- Host: GitHub
- URL: https://github.com/onadrog/idbapi
- Owner: onadrog
- License: apache-2.0
- Created: 2023-05-05T15:14:05.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-10T08:11:00.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T19:34:32.651Z (4 months ago)
- Topics: indexeddb, typescrit
- Language: TypeScript
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IDB class
A simple implementation of IndexedDB api.
## Getting started
```js
import {IdbClass} from "idb-class"
const idb = new IdbClass();
```
See the [demo](./demo) file
## Implemented Methods
- addData(data: T, key?: IDBValidKey): void
- updateData(data: T, key: IDBValidKey): void
- close()
- deleteData(key: IDBValidKey | IDBKeyRange): void
- deletaDatabase()
## TODO
- implement [IDBObjectStore methods](https://developer.mozilla.org/fr/docs/Web/API/IDBObjectStore)
## Developement
```sh
$ make test # run a containerized playwright docker.
```
## LICENSE
Copyright 2023 Sébastien Gordano
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.