From 3aab81bc35305b5adda5d8c731cfb43b0ff202f9 Mon Sep 17 00:00:00 2001 From: David Luzar Date: Sun, 27 Dec 2020 23:17:27 +0100 Subject: [PATCH] docs: add tsdoc for certain element props (#2673) Co-authored-by: Panayiotis Lipiridis --- src/element/types.ts | 10 ++++++++++ src/packages/excalidraw/CHANGELOG.md | 4 ++++ 2 files changed, 14 insertions(+) diff --git a/src/element/types.ts b/src/element/types.ts index 8a7b26ec..baeb001a 100644 --- a/src/element/types.ts +++ b/src/element/types.ts @@ -27,11 +27,21 @@ type _ExcalidrawElementBase = Readonly<{ width: number; height: number; angle: number; + /** Random integer used to seed shape generation so that the roughjs shape + doesn't differ across renders. */ seed: number; + /** Integer that is sequentially incremented on each change. Used to reconcile + elements during collaboration or when saving to server. */ version: number; + /** Random integer that is regenerated on each change. + Used for deterministic reconciliation of updates during collaboration, + in case the versions (see above) are identical. */ versionNonce: number; isDeleted: boolean; + /** List of groups the element belongs to. + Ordered from deepest to shallowest. */ groupIds: readonly GroupId[]; + /** Ids of (linear) elements that are bound to this element. */ boundElementIds: readonly ExcalidrawLinearElement["id"][] | null; }>; diff --git a/src/packages/excalidraw/CHANGELOG.md b/src/packages/excalidraw/CHANGELOG.md index ab26fdf3..ecc9cc13 100644 --- a/src/packages/excalidraw/CHANGELOG.md +++ b/src/packages/excalidraw/CHANGELOG.md @@ -51,6 +51,10 @@ Please add the latest change on the top under the correct section. - Bump ini from 1.3.5 to 1.3.7 in /src/packages/excalidraw [#2500](https://github.com/excalidraw/excalidraw/pull/2500) +### Docs + +- Document some of the more exotic element props [#2673](https://github.com/excalidraw/excalidraw/pull/2673) + ## 0.1.1 #### Fix