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

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

# Function: readDocByQuery()

> **readDocByQuery**(`query`, `options?`): `Promise`\<\{ `content`: `string`; `entry`: [`DocEntry`](../interfaces/DocEntry.md); \} \| `null`\>

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

Reads documentation by fuzzy-matching the query and returning the best match.

## Parameters

### query

`string`

The search query string

### options?

[`SearchDocsOptions`](../interfaces/SearchDocsOptions.md)

Optional search constraints (e.g. category)

## Returns

`Promise`\<\{ `content`: `string`; `entry`: [`DocEntry`](../interfaces/DocEntry.md); \} \| `null`\>

The best matching entry and its content, or null if no match

## Example

```typescript
const doc = await readDocByQuery('ProductMgr');
if (doc) console.log(doc.content);
```