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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [discovery](../index.md) / DetectOptions

# Interface: DetectOptions

Defined in: [packages/b2c-tooling-sdk/src/discovery/types.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/discovery/types.ts#L81)

Options for workspace detection.

## Properties

### additionalPatterns?

> `optional` **additionalPatterns**: [`DetectionPattern`](DetectionPattern.md)[]

Defined in: [packages/b2c-tooling-sdk/src/discovery/types.ts:85](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/discovery/types.ts#L85)

Additional patterns to include

***

### excludePatterns?

> `optional` **excludePatterns**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/discovery/types.ts:87](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/discovery/types.ts#L87)

Patterns to exclude by name

***

### maxDepth?

> `optional` **maxDepth**: `number`

Defined in: [packages/b2c-tooling-sdk/src/discovery/types.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/discovery/types.ts#L94)

Maximum directory depth (in path segments, relative to the workspace root)
that filesystem-scanning patterns recurse. Undefined means unbounded.
Passed to each pattern via [DetectionContext](DetectionContext.md). Set this when detecting
from a potentially broad root to keep the scan bounded.

***

### patterns?

> `optional` **patterns**: [`DetectionPattern`](DetectionPattern.md)[]

Defined in: [packages/b2c-tooling-sdk/src/discovery/types.ts:83](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/discovery/types.ts#L83)

Custom patterns to use (replaces defaults)