Skip to content
View as Markdown
View as Markdown

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

Function: readSchemaByQuery()

readSchemaByQuery(query): { content: string; entry: SchemaEntry; path: string; } | null

Defined in: packages/b2c-tooling-sdk/src/docs/schema.ts:91

Find a schema by fuzzy query and return its content. First attempts an exact ID match, then falls back to fuzzy search. Returns the best match or null if no match found.

Parameters

query

string

The search query string (can be exact schema ID or fuzzy search term)

Returns

{ content: string; entry: SchemaEntry; path: string; } | null

Object containing the schema entry, file content, and file path; or null if no match found

Released under the Apache-2.0 License.