Function parseExampleContent

parseExampleContent<T = unknown>(
example: Pick<ZcapSpecExample, "content" | "mediaType">,
): T
Parse an example's content into a JavaScript value.

Saves callers from having to care whether a given example is strict JSON or JSON-with-comments, and from pulling in a JSONC parser to find out. Most zcap-spec examples are annotated with // commentary and so are not valid JSON — JSON.parse(example.content) throws on them, which is the trap this exists to remove.

Handles application/json, application/jsonc, and any +json type such as application/ld+json. Media-type parameters (; charset=utf-8) are ignored. Comments are stripped only if a direct parse fails, so a correctly-labelled document is never rewritten unnecessarily — and a mislabelled one still parses.
Type Parameters
- T = unknown
  What you expect back. Unchecked, exactly like JSON.parse; defaults to unknown so the cast is your decision.
Parameters
- example: Pick<ZcapSpecExample, "content" | "mediaType">
  Any object with content and mediaType, such as a ZcapSpecExample.
Returns T
The parsed value.
Throws
If the media type has no object representation (for example message/http or text/plain) — read example.content instead.

Throws
If the content is that media type but does not parse.
Example: Parse every example, whatever flavour it is
```
for (const example of extractExamplesFromHtml(zcapSpecHtml)) {
  const value = parseExampleContent(example);
  console.log(value["@context"]);
}
```
Example: Tell TypeScript what you expect
```
const capability = parseExampleContent<{ "@context": string | string[] }>(example);
```
- Defined in examples.ts:705

Function parseExampleContent

Type Parameters

Parameters

Returns T

Throws

Throws

Example: Parse every example, whatever flavour it is

Example: Tell TypeScript what you expect

Settings