Skip to content

Commit

Permalink
updated docs and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
wesone committed Jun 16, 2021
1 parent 0666b24 commit 0446275
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Bug where idempotency in read model store fails for multiple inserts/updates per event
- Bug where projections handle events in a wrong order during a replay

### Added
- New option `index` for ReadModelStore.defineTable scheme, to allow B-Tree and FULLTEXT indexing of fields

## [1.1.2] - 2021-05-05
### Changed
- Renamed workflow property `currentEvent` to `event`
Expand Down
1 change: 1 addition & 0 deletions docs/ReadModelStoreAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Property | Type | Attribute | Description
type | string | | The fields data type. Can be one of the following:<br>`boolean` true or false<br>`date` Dates like JavaScript Date objects<br>`json` Objects that can be JSON serialized<br>`number` Positive or negative float or integer<br>`string` Strings with a max length of 512 characters<br>`text` Strings of indefinite length<br>`uuid` Strings with 36 characters
primaryKey | boolean | optional | Sets the field as Primary key
unique | boolean | optional | Sets the field to be unique across all entries
index | boolean \| string | optional | Adds an index to the field. If index is `true`, B-Tree indexing is used, other values are:<br>`btree` B-Tree indexing<br>`fulltext` FULLTEXT indexing

## options
Property | Type | Attribute | Description
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"main": "src/index.js",
"scripts": {
"test": "jest --testMatch=**/test/**/*.test.js --verbose --passWithNoTests",
"coverage": "jest --coverage"
"coverage": "jest --coverage",
"docs": "npx docsify serve docs"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 0446275

Please sign in to comment.