chore: add documentation/comments to props

This commit is contained in:
Ayo 2023-07-16 21:40:43 +02:00
parent 7b72595909
commit 9ccd6eb132

View file

@ -1,7 +1,14 @@
--- ---
type Primitive = string | number | boolean | null | undefined; type Primitive = string | number | boolean | null | undefined;
export interface Props { export interface Props {
/**
* The id that the client script will pass to the `resume()` function
*/
id: string; id: string;
/**
* The data to be serialized and accessed in the client script with `resume()`
*/
data: Record<string, Primitive>; data: Record<string, Primitive>;
} }
const {id, data} = Astro.props; const {id, data} = Astro.props;