Skip to content
View as Markdown
View as Markdown

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

Function: readDoc()

readDoc(id): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:469

Reads the full content of a documentation entry by its exact id.

Bundled entries are read from disk. Entries whose content is published online (Developer Center guides) are fetched from their canonical URL; on network failure a readable fallback assembled from the indexed metadata is returned.

Parameters

id

string

The documentation id

Returns

Promise<string>

The document content (markdown)

Throws

Error if the id is unknown

Released under the Apache-2.0 License.