{"schemaVersion":1,"title":"Portable metadata · manual example","url":"https://appgram.github.io/docsy/versions/current/es/compact-sdk","markdownUrl":"https://appgram.github.io/docsy/format-md/versions/current/es/compact-sdk","jsonUrl":"https://appgram.github.io/docsy/agent/pages/versions/current/es/compact-sdk.json","version":"current","locale":"es","markdown":"# Portable metadata · manual example\n\nAn explicitly hand-authored compact-format example for custom converters. Not a native generator fixture and not counted among the 20 native languages.\n\n> Source: https://appgram.github.io/docsy/versions/current/es/compact-sdk  \n> Language: typescript  \n> Symbols: 4 across 4 categories\n\n## Categories\n\n- [Clients](#clients) — 1 items\n- [Models](#models) — 1 items\n- [Hooks](#hooks) — 1 items\n- [Enums](#enums) — 1 items\n\n## Clients\n\n### `AtlasClient`  <sub>class</sub>\n\nAn asynchronous client for the fictional Atlas document API.\n\n**Properties**\n\n| Name | Type | Required | Description | Default |\n\n| --- | --- | --- | --- | --- |\n\n| `baseUrl` | `string` | ✓ | The configured API origin. |  |\n\n**Methods**\n\n- `getDocument` — async → `Promise<Document>`  \n  Fetch a document by its stable identifier.\n\n  - `id: string` — Document identifier.\n\n```typescript\ndeclare class AtlasClient {\n  constructor(options: { baseUrl: string });\n  getDocument(id: string): Promise<Document>;\n}\n```\n\n**Example**\n\n```typescript\nconst client = new AtlasClient({ baseUrl: \"https://api.example.com\" });\nconst document = await client.getDocument(\"intro\");\n```\n\n## Models\n\n### `Document`  <sub>interface</sub>\n\nA document returned by the Atlas API.\n\n**Properties**\n\n| Name | Type | Required | Description | Default |\n\n| --- | --- | --- | --- | --- |\n\n| `id` | `string` | ✓ | Stable identifier. |  |\n\n| `title` | `string` | ✓ | Human-readable title. |  |\n\n| `state` | `DocumentState` | ✓ | Publication state. |  |\n\n```typescript\ninterface Document {\n  id: string;\n  title: string;\n  state: DocumentState;\n}\n```\n\n## Hooks\n\n### `useDocument`  <sub>hook</sub>\n\nA React hook for loading one document.\n\n**Parameters**\n\n| Name | Type | Required | Description |\n\n| --- | --- | --- | --- |\n\n| `id` | `string` | ✓ | Stable document identifier. |\n\n**Returns** — `{ document?: Document; loading: boolean }` — The current document and loading state.\n\n```typescript\ndeclare function useDocument(id: string): {\n  document?: Document;\n  loading: boolean;\n};\n```\n\n**Example**\n\n```typescript\nconst { document, loading } = useDocument(\"intro\");\n```\n\n## Enums\n\n### `DocumentState`  <sub>enum</sub>\n\nThe publication state of a document.\n\n**Values** — `draft`, `published`, `archived`\n"}