SDK types

The SDK type reference is generated from the package types with TypeDoc and is being wired in. Until it lands here, each SDK’s API reference page documents the types it exports — Article, ArticleImage, Author, the option interfaces, and GhostwritrError.

One shared contract

The article types are hand-authored in @ghostwritr/feed and re-exported by every framework wrapper, so Article, ArticleImage, and Author are identical across next, astro, react-router, and feed. The field-by-field walkthrough is on The article shape.

API reference per SDK

@ghostwritr/next createGhostwritr, the Ghostwritr client, createRevalidateHandler, and the exported types.

@ghostwritr/astro The ghostwritr() loader, its options, and the collection schema types.

@ghostwritr/react-router fetchArticles, fetchArticle, articleMeta, and the webhook helpers.

@ghostwritr/feed The framework-agnostic core: fetchers, types, and webhook signing.

What to reach for next

• The article shape — every field and what null means. See The article shape.
• Error handling — GhostwritrError, its code, and status. See Error handling.