Skip to content

Commit 1ebbdfe

Browse files
committed
[docs] Release notes
1 parent 73db2ee commit 1ebbdfe

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

site/guides/15_releases.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,30 @@ This release changes the `package.json` exports slightly so that imports of both
1414
JavaScript file. This reduces bundle size for apps that use both schema and
1515
non-schema imports.
1616

17+
## New `omni` module
18+
19+
The new `omni` module is an explicit superset of everything in the TinyBase
20+
ecosystem. It includes all the features and functionality of the existing
21+
modules, including every persister, every UI component, and every synchronizer.
22+
This is useful for applications that want to use multiple facets of the overall
23+
TinyBase ecosystem and also benefit from the shared code they use internally.
24+
25+
However, it should go without saying that you should only use the `omni` module
26+
if you have a good tree-shaking bundler that can remove all the persisters,
27+
synchronizers, and so on, that you do NOT use.
28+
29+
## HLC functions
30+
31+
The common module (and hence tinybase module) now export the getHlcFunction
32+
function. This returns set of seven functions that can be used to create and
33+
manipulate HLC (Hybrid Logical Clock) timestamps. If needed, you can use these
34+
in your own systems to ensure the timestamps are compatible with the ones
35+
generated in TinyBase MergeableStore objects.
36+
1737
## Move of the GetNow type
1838

19-
The rarely-used GetNow type has been moved from the mergeable-store module into the common module.
39+
The rarely-used GetNow type has been moved from the mergeable-store module into
40+
the common module.
2041

2142
# v6.1
2243

0 commit comments

Comments
 (0)