@salesforce/b2c-tooling-sdk / docs

docs

Documentation search for B2C Commerce Script API.

Provides functions for downloading documentation from B2C instances and searching bundled documentation locally.

Download Documentation

Use downloadDocs to download documentation from a B2C instance:

import { downloadDocs } from '@salesforce/b2c-tooling-sdk/docs';
import { B2CInstance } from '@salesforce/b2c-tooling-sdk';

const instance = B2CInstance.fromEnvironment();
const result = await downloadDocs(instance, { outputDir: './docs' });
console.log(`Downloaded ${result.fileCount} files`);

Search Bundled Docs

Use searchDocs and readDocByQuery to search and read bundled documentation:

import { searchDocs, readDocByQuery } from '@salesforce/b2c-tooling-sdk/docs';

// Search for documentation
const results = searchDocs('ProductMgr');
results.forEach(r => console.log(r.entry.id, r.score));

// Read a specific doc by fuzzy query
const doc = readDocByQuery('dw.catalog.ProductMgr');
if (doc) {
  console.log(doc.content);
}

Interfaces

• DocEntry
• DownloadDocsOptions
• DownloadDocsResult
• SchemaEntry
• SchemaIndex
• SchemaSearchResult
• SearchIndex
• SearchResult

Functions

• downloadDocs
• listDocs
• listSchemas
• loadSearchIndex
• readDoc
• readDocByQuery
• readSchema
• readSchemaByQuery
• searchDocs
• searchSchemas