Skip to the content.

Home > @nabh/ts-api-extractor > APIExtractor > extract

APIExtractor.extract() method

Signature:

static extract(pkg: string, basePkg?: APIPackage): APIMetadata;

Parameters

Parameter Type Description
pkg string Name or root directory of the target package
basePkg APIPackage (Optional) Used to look up the target package if it is locally installed in the base package

Returns:

APIMetadata

API metadata for the target package