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

Function: readDocByQuery()

readDocByQuery(query, options?): Promise<{ content: string; entry: DocEntry; } | null>

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

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

Parameters

query

string

The search query string

options?

SearchDocsOptions

Optional search constraints (e.g. category)

Returns

Promise<{ content: string; entry: DocEntry; } | null>

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

Example

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