chore: remove long example
This commit is contained in:
parent
4b29419ed3
commit
632e433add
1 changed files with 1 additions and 23 deletions
|
@ -4,29 +4,7 @@
|
||||||
* @param parser Custom parser to be used
|
* @param parser Custom parser to be used
|
||||||
* @returns The deserialized JSON data
|
* @returns The deserialized JSON data
|
||||||
* @see Usage examples in 👉 https://git.sr.ht/~ayoayco/astro-resume#astro-resume
|
* @see Usage examples in 👉 https://git.sr.ht/~ayoayco/astro-resume#astro-resume
|
||||||
* @example
|
**/
|
||||||
*
|
|
||||||
* To make all `Astro.props` available in your client script:
|
|
||||||
*
|
|
||||||
* ```astro
|
|
||||||
* ---
|
|
||||||
* import Serialize from "@ayco/astro-resume";
|
|
||||||
* export interface Props {
|
|
||||||
* hello: string;
|
|
||||||
* isOkay: boolean;
|
|
||||||
* }
|
|
||||||
* ---
|
|
||||||
*
|
|
||||||
* <Serialize id="preferences" data={{...Astro.props}} />
|
|
||||||
*
|
|
||||||
* <script>
|
|
||||||
* import {deserialize} from '@ayco/astro-resume';
|
|
||||||
* import type {Props} from './ThisComponent.astro';
|
|
||||||
* const {hello, isOkay} = deserialize<Props>('preferences');
|
|
||||||
* console.log(hello, isOkay);
|
|
||||||
* </script>
|
|
||||||
* ```
|
|
||||||
**/
|
|
||||||
export function deserialize<T = any>(id: string, parser?: (serialized: string)=>any): T {
|
export function deserialize<T = any>(id: string, parser?: (serialized: string)=>any): T {
|
||||||
const elements = document.querySelectorAll<HTMLScriptElement>(`script#${id}[type="application/json"]`);
|
const elements = document.querySelectorAll<HTMLScriptElement>(`script#${id}[type="application/json"]`);
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue