@salesforce/b2c-tooling-sdk / docs / SearchDocsOptions
Interface: SearchDocsOptions
Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:319
Options for searchDocs.
Properties
category?
optionalcategory:DocCategory|DocCategory[]
Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:323
Restrict results to one or more corpora/categories (hard filter).
enabledCategories?
optionalenabledCategories: readonlyDocCategory[]
Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:342
A hard allowlist of categories that bounds the ENTIRE available corpus for this call — a configuration boundary, distinct from the per-query SearchDocsOptions.category filter and the soft workspace boost.
When set, only entries in these categories are ever eligible; any category narrows within this set (their intersection wins). Intended to be resolved once from a launch-time flag/env var (see resolveEnabledCategories) so operators can pin the docs surface to exactly the topics they want exposed. undefined means no restriction.
limit?
optionallimit:number
Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:321
Maximum number of results to return (default: 20).
workspace?
optionalworkspace:ProjectType|ProjectType[]
Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:330
The current workspace marker(s) (e.g. from workspace detection). When set, the categories relevant to those markers rank higher (always a boost — never hides anything). To hard-scope instead, use SearchDocsOptions.category or SearchDocsOptions.enabledCategories.