@salesforce/b2c-tooling-sdk / docs / DocEntry

Interface: DocEntry

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:23

A documentation entry in the search index.

Properties

filePath

filePath: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:29

The filename (e.g., "dw.catalog.ProductMgr.md")

---

id

id: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:25

Unique identifier - the filename without .md extension (e.g., "dw.catalog.ProductMgr")

---

preview?

optional preview: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:31

Optional preview/excerpt from the document

---

title

title: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:27

The title from the document heading (e.g., "Class ProductMgr")