PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/packages/file-format
History
Steve Ruiz ed8d4d9e05
[improvement] store snapshot types (#1657) 
This PR improves the types for the Store.

- renames `StoreSnapshot` to `SerializedStore`, which is the return type
of `Store.serialize`
- creates `StoreSnapshot` as a type for the return type of
`Store.getSnapshot` / the argument type for `Store.loadSnapshot`
- creates `TLStoreSnapshot` as the type used for the `TLStore`.

This came out of a session I had with a user. This should prevent
needing to import types from `@tldraw/store` directly.

### Change Type

- [x] `major` — Breaking change

### Test Plan

- [x] Unit Tests

### Release Notes

- [dev] Rename `StoreSnapshot` to `SerializedStore`
- [dev] Create new `StoreSnapshot` as type related to
`getSnapshot`/`loadSnapshot`
2023-06-27 12:25:55 +00:00
..
src [improvement] store snapshot types (#1657) 2023-06-27 12:25:55 +00:00
api-extractor.json transfer-out: transfer out 2023-04-25 12:01:25 +01:00
api-report.md mini defineShape API (#1563) 2023-06-12 14:04:14 +00:00
LICENSE transfer-out: transfer out 2023-04-25 12:01:25 +01:00
package.json update lazyrepo 2023-06-05 18:32:32 +01:00
README.md readmes 2023-05-04 13:47:56 +01:00
tsconfig.json Rename tlstore to store (#1507) 2023-06-03 08:59:04 +00:00

README.md

@tldraw/file-format

License

The source code in this repository (as well as our 2.0+ distributions and releases) are currently licensed under Apache-2.0. These licenses are subject to change in our upcoming 2.0 release. If you are planning to use tldraw in a commercial product, please reach out at hello@tldraw.com.