From 9ccd6eb1326d0591c79882d5a1406e05c24d5d0d Mon Sep 17 00:00:00 2001 From: Ayo Date: Sun, 16 Jul 2023 21:40:43 +0200 Subject: [PATCH] chore: add documentation/comments to props --- src/Resumable.astro | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/Resumable.astro b/src/Resumable.astro index b68c505..068e2c1 100644 --- a/src/Resumable.astro +++ b/src/Resumable.astro @@ -1,7 +1,14 @@ --- type Primitive = string | number | boolean | null | undefined; + export interface Props { + /** + * The id that the client script will pass to the `resume()` function + */ id: string; + /** + * The data to be serialized and accessed in the client script with `resume()` + */ data: Record; } const {id, data} = Astro.props;