craft-hub / ProjectReadme

Interface: ProjectReadme

Defined in: packages/craft-hub/src/types.ts:289

Result of safely resolving one project or package README.

Properties

content?

optional content?: string

Defined in: packages/craft-hub/src/types.ts:294

UTF-8 Markdown returned only for a valid, bounded README.

---

message?

optional message?: string

Defined in: packages/craft-hub/src/types.ts:295

---

path?

optional path?: string

Defined in: packages/craft-hub/src/types.ts:292

Project-relative README path when one candidate was resolved.

---

status

status: "invalid" | "missing" | "found" | "unreadable" | "too-large"

Defined in: packages/craft-hub/src/types.ts:290