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

[@salesforce/b2c-tooling-sdk](../modules.md) / 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](functions/downloadDocs.md) to download documentation from a B2C instance:

```typescript
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](functions/searchDocs.md) and [readDocByQuery](functions/readDocByQuery.md) to search and read bundled documentation:

```typescript
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 = await readDocByQuery('dw.catalog.ProductMgr');
if (doc) {
  console.log(doc.content);
}
```

## Interfaces

- [CachedEntry](interfaces/CachedEntry.md)
- [ContentCacheStats](interfaces/ContentCacheStats.md)
- [DocEntry](interfaces/DocEntry.md)
- [DownloadDocsOptions](interfaces/DownloadDocsOptions.md)
- [DownloadDocsResult](interfaces/DownloadDocsResult.md)
- [SchemaEntry](interfaces/SchemaEntry.md)
- [SchemaIndex](interfaces/SchemaIndex.md)
- [SchemaSearchResult](interfaces/SchemaSearchResult.md)
- [SearchDocsOptions](interfaces/SearchDocsOptions.md)
- [SearchIndex](interfaces/SearchIndex.md)
- [SearchResult](interfaces/SearchResult.md)

## Type Aliases

- [CacheSource](type-aliases/CacheSource.md)
- [DocCategory](type-aliases/DocCategory.md)

## Variables

- [DEFAULT\_CACHE\_TTL\_MS](variables/DEFAULT_CACHE_TTL_MS.md)
- [DOC\_CATEGORIES](variables/DOC_CATEGORIES.md)

## Functions

- [categoriesForWorkspace](functions/categoriesForWorkspace.md)
- [clearContentCache](functions/clearContentCache.md)
- [downloadDocs](functions/downloadDocs.md)
- [getCachedContent](functions/getCachedContent.md)
- [getCachedEntry](functions/getCachedEntry.md)
- [getContentCacheStats](functions/getContentCacheStats.md)
- [initializeContentCache](functions/initializeContentCache.md)
- [listDocs](functions/listDocs.md)
- [listSchemas](functions/listSchemas.md)
- [loadSearchIndex](functions/loadSearchIndex.md)
- [purgeContentCache](functions/purgeContentCache.md)
- [readDoc](functions/readDoc.md)
- [readDocByQuery](functions/readDocByQuery.md)
- [readEntryContent](functions/readEntryContent.md)
- [readSchema](functions/readSchema.md)
- [readSchemaByQuery](functions/readSchemaByQuery.md)
- [resetDocsCache](functions/resetDocsCache.md)
- [resolveEnabledCategories](functions/resolveEnabledCategories.md)
- [searchDocs](functions/searchDocs.md)
- [searchSchemas](functions/searchSchemas.md)
- [setCachedContent](functions/setCachedContent.md)