Skip to content

Commit

Permalink
chore(release): 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
darrachequesne committed Oct 7, 2024
1 parent 3ffd2f4 commit 8d2ab81
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# History

| Version | Release date |
|--------------------------|----------------|
| [0.1.0](#010-2024-10-07) | September 2024 |
| [0.0.2](#002-2022-03-26) | March 2022 |
| [0.0.1](#001-2022-03-25) | March 2022 |

# Release notes

## [0.1.0](https://github.com/darrachequesne/synceddb/compare/0.0.2...0.1.0) (2024-10-07)


### Features

* add support for object stores without keyPath ([b59b095](https://github.com/darrachequesne/synceddb/commit/b59b095326d7b71a86ce73f961cdac5b32db59d1))
* update the format of the default search params ([3ffd2f4](https://github.com/darrachequesne/synceddb/commit/3ffd2f4c441b7e44d2319e61b506e8dbb1664793))


### BREAKING CHANGES

* The format of the default search params is updated:

Before: `?sort=updated_at:asc&size=100&after=2000-01-01T00:00:00.000Z,123`

After: `?sort=updated_at:asc&size=100&after=2000-01-01T00:00:00.000Z&after_id=123`



## [0.0.2](https://github.com/darrachequesne/synceddb/compare/0.0.1...0.0.2) (2022-03-26)


Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,6 @@ Inspired from [Dexie.js liveQuery](https://dexie.org/docs/liveQuery()).

# Disclaimer

- [out-of-line keys](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#out-of-line_key)

Entities without `keyPath` are not currently supported.

- no version history

Only the last version of each entity is kept on the client side.
Expand Down Expand Up @@ -492,14 +488,14 @@ onBeforeUnmount(() => {
Changes are fetched from the REST API with `GET` requests:
```
GET /<storeName>?sort=updated_at:asc&size=100&after=2000-01-01T00:00:00.000Z,123
GET /<storeName>?sort=updated_at:asc&size=100&after=2000-01-01T00:00:00.000Z&after_id=123
```
Explanations:
- `sort=updated_at:asc` indicates that we want to sort the entities based on the date of last update
- `size=100` indicates that we want 100 entities max
- `after=2000-01-01T00:00:00.000Z,123` indicates the offset (with an update date above `2000-01-01T00:00:00.000Z`, excluding the entity `123`)
- `after=2000-01-01T00:00:00.000Z&after_id=123` indicates the offset (with an update date above `2000-01-01T00:00:00.000Z`, excluding the entity `123`)
The query parameters can be customized with the [`buildFetchParams`](#buildfetchparams) option.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "synceddb",
"version": "0.0.2",
"version": "0.1.0",
"description": "Sync your IndexedDB database with a remote REST API",
"main": "./build/index.cjs",
"module": "./build/index.js",
Expand Down

0 comments on commit 8d2ab81

Please sign in to comment.