Portable metadata · manual example

An explicitly hand-authored compact-format example for custom converters. Not a native generator fixture and not counted among the 20 native languages.

4 symbols4 categoriestypescript

Clients

class

AtlasClient

An asynchronous client for the fictional Atlas document API.

Properties

baseUrlstring

The configured API origin.

Methods

getDocumentasync→ Promise<Document>

Fetch a document by its stable identifier.

id: string

Declaration

declare class AtlasClient {
  constructor(options: { baseUrl: string });
  getDocument(id: string): Promise<Document>;
}

Example

const client = new AtlasClient({ baseUrl: "https://api.example.com" });
const document = await client.getDocument("intro");

Models

interface

Document

A document returned by the Atlas API.

Properties

idstring

Stable identifier.

titlestring

Human-readable title.

stateDocumentState

Publication state.

Hooks

hook

useDocument

A React hook for loading one document.

Parameters

idstring

Stable document identifier.

Returns

{ document?: Document; loading: boolean }

The current document and loading state.

Enums

enum

DocumentState

The publication state of a document.

Values

draftpublishedarchived