@@ -11,20 +11,6 @@ This release contains various packaging improvements and exposes some internal
1111HLC functions that are useful for people building their own persisters or
1212synchronizers.
1313
14- ## HLC functions
15-
16- The common module (and hence tinybase module) now export the getHlcFunction
17- function. This returns set of seven functions that can be used to create and
18- manipulate HLC (Hybrid Logical Clock) timestamps.
19-
20- ``` js
21- import {getHlcFunctions } from ' tinybase' ;
22- const [getNextHlc , seenHlc , encodeHlc ] = getHlcFunctions ();
23- ```
24-
25- If needed, you can use these in your own systems to ensure the timestamps are
26- compatible with the ones generated in TinyBase MergeableStore objects.
27-
2814## New ` omni ` module
2915
3016There is a new ` omni ` module that is an explicit superset of everything in the
@@ -49,7 +35,26 @@ This release changes the `package.json` exports slightly so that imports of both
4935JavaScript file. This reduces bundle size for apps that use both schema and
5036non-schema imports.
5137
52- ## Moving types
38+ ## HLC & hash functions
39+
40+ The common module (and hence tinybase module) now export the getHlcFunction
41+ function. This returns set of seven functions that can be used to create and
42+ manipulate HLC (Hybrid Logical Clock) timestamps.
43+
44+ ``` js
45+ import {getHlcFunctions } from ' tinybase' ;
46+ const [getNextHlc , seenHlc , encodeHlc ] = getHlcFunctions ();
47+ ```
48+
49+ There are also several functions to help hash tabular and key-value data in a
50+ way that is compatible with the internal MergeableStore implementation. These
51+ include the getHash function and the getCellHash function, for example.
52+
53+ These are for pretty advanced use-cases! But you can use these in your own
54+ systems to ensure the timestamps and hashes are compatible with the ones
55+ generated in TinyBase MergeableStore objects.
56+
57+ ## Moved types
5358
5459The rarely-used GetNow and Hash types have been moved from the mergeable-store
5560module into the common module.
0 commit comments