RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > IApiPackageSaveOptions

IApiPackageSaveOptions interface

Options for ApiPackage.saveToJsonFile() .

Signature:
export interface IApiPackageSaveOptions extends IJsonFileSaveOptions
Extends: [IJsonFileSaveOptions](/pages/node-core-library.ijsonfilesaveoptions)

Properties

PropertyTypeDescription
testMode?boolean(Optional) Set to true only when invoking API Extractor's test harness.
toolPackage?string(Optional) Optionally specifies a value for the "toolPackage" field in the output .api.json data file; otherwise, the value will be "api-extractor-model".
toolVersion?string(Optional) Optionally specifies a value for the "toolVersion" field in the output .api.json data file; otherwise, the value will be the current version of the api-extractor-model package.