---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [docs](../index.md) / SearchDocsOptions

# Interface: SearchDocsOptions

Defined in: [packages/b2c-tooling-sdk/src/docs/search.ts:319](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/search.ts#L319)

Options for [searchDocs](../functions/searchDocs.md).

## Properties

### category?

> `optional` **category**: [`DocCategory`](../type-aliases/DocCategory.md) \| [`DocCategory`](../type-aliases/DocCategory.md)[]

Defined in: [packages/b2c-tooling-sdk/src/docs/search.ts:323](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/search.ts#L323)

Restrict results to one or more corpora/categories (hard filter).

***

### enabledCategories?

> `optional` **enabledCategories**: readonly [`DocCategory`](../type-aliases/DocCategory.md)[]

Defined in: [packages/b2c-tooling-sdk/src/docs/search.ts:342](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/search.ts#L342)

A hard allowlist of categories that bounds the ENTIRE available corpus for
this call — a configuration boundary, distinct from the per-query
[SearchDocsOptions.category](#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](../functions/resolveEnabledCategories.md)) so
operators can pin the docs surface to exactly the topics they want exposed.
`undefined` means no restriction.

***

### limit?

> `optional` **limit**: `number`

Defined in: [packages/b2c-tooling-sdk/src/docs/search.ts:321](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/search.ts#L321)

Maximum number of results to return (default: 20).

***

### workspace?

> `optional` **workspace**: [`ProjectType`](../../discovery/type-aliases/ProjectType.md) \| [`ProjectType`](../../discovery/type-aliases/ProjectType.md)[]

Defined in: [packages/b2c-tooling-sdk/src/docs/search.ts:330](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/search.ts#L330)

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](#category)
or [SearchDocsOptions.enabledCategories](#enabledcategories).