Skip to content
View as Markdown
View as Markdown

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

Function: listDocs()

listDocs(category?, enabledCategories?): DocEntry[]

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

Lists documentation entries, optionally filtered by category.

Parameters

category?

Optional corpus/category (or list) to restrict to

DocCategory | DocCategory[]

enabledCategories?

readonly DocCategory[]

Optional launch-time allowlist that bounds the entire corpus (see SearchDocsOptions.enabledCategories). When set, only entries in these categories are eligible; category narrows within it.

Returns

DocEntry[]

Array of matching documentation entries

Released under the Apache-2.0 License.