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

Function: downloadDocs()

downloadDocs(instance, options): Promise<DownloadDocsResult>

Defined in: packages/b2c-tooling-sdk/src/docs/download.ts:59

Downloads documentation archive from a B2C instance.

The archive is available at a special URL: https://{hostname}:443/on/demandware.servlet/WFS/Studio/Sites/mock/demandware-mock.zip

The outer zip contains DWAPP-*.API-doc.zip which contains sfdocs/script-api/ with markdown docs.

Parameters

instance

B2CInstance

B2C instance to download from

options

DownloadDocsOptions

Download options

Returns

Promise<DownloadDocsResult>

Download result with extraction details

Throws

Error if download fails or credentials are missing

Example

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