@jsdocs-io/extractor

constructor

constructor(bunCmd?: string);

method add

add: (pkg: string, cwd: string) => Promise<string[]>;

• add installs the given package in the given directory and returns a list of all installed packages (e.g., ["foo@1.0.0"]).

  See Also

  • https://bun.sh/docs/cli/add

property docs

docs: string[];

• List of associated JSDoc comments.

property file

file: string;

• Name of the file where the declaration is defined.

property id

id: string;

• Unique ID.

property line

line: number;

• Line number where the declaration is defined.

property name

name: string;

• Export name (may differ from the original name).

property signature

signature: string;

• Declaration signature.

property constructors

constructors: ExtractedClassConstructor[];

property kind

kind: 'class';

property methods

methods: ExtractedClassMethod[];

property properties

properties: ExtractedClassProperty[];

property kind

kind: 'class-constructor';

property kind

kind: 'class-method';

property kind

kind: 'class-property';

property kind

kind: 'enum';

property members

members: ExtractedEnumMember[];

property kind

kind: 'enum-member';

property kind

kind: 'function';

property callSignatures

callSignatures: ExtractedInterfaceCallSignature[];

property constructSignatures

constructSignatures: ExtractedInterfaceConstructSignature[];

property getAccessors

getAccessors: ExtractedInterfaceGetAccessor[];

property indexSignatures

indexSignatures: ExtractedInterfaceIndexSignature[];

property kind

kind: 'interface';

property methods

methods: ExtractedInterfaceMethod[];

property properties

properties: ExtractedInterfaceProperty[];

property setAccessors

setAccessors: ExtractedInterfaceSetAccessor[];

property kind

kind: 'interface-call-signature';

property kind

kind: 'interface-construct-signature';

property kind

kind: 'interface-get-accessor';

property kind

kind: 'interface-index-signature';

property kind

kind: 'interface-method';

property kind

kind: 'interface-property';

property kind

kind: 'interface-set-accessor';

property declarations

declarations: ExtractedDeclaration[];

property kind

kind: 'namespace';

property kind

kind: 'type';

property kind

kind: 'variable';

property bun

bun?: Bun;

• Bun instance used to install the package.

property maxDepth

maxDepth?: number;

• Packages can have deeply nested modules and namespaces.

  Use maxDepth to limit the depth of the extraction. Declarations nested at levels deeper than this value will be ignored.

property pkg

pkg: string;

• Package to extract the API from.

  This can be either a package name (e.g., foo, @foo/bar) or any other query that can be passed to bun add (e.g., foo@1.0.0).

  See Also

  • Bun docs

property subpath

subpath?: string;

• Specific subpath to consider in a package.

  If a package has multiple entrypoints listed in the exports map property of its package.json, use subpath to select a specific one by its name (e.g., someFeature).

  See Also

  • Node.js docs

  • resolve.exports docs

property pkgJson

pkgJson: Partial<NormalizedPackageJson>;

• The contents of the package.json file.

property subpath

subpath?: string;

• The subpath for which to resolve the types condition.

property analyzedAt

analyzedAt: string;

• Timestamp of when the package was analyzed.

property analyzedIn

analyzedIn: number;

• Package analysis duration in milliseconds.

property declarations

declarations: ExtractedDeclaration[];

• Declarations exported (or re-exported) by the package.

property dependencies

dependencies: string[];

• All packages resolved and installed when installing the package (included).

  Example 1

  ```ts // Installing foo brings in also bar and baz as dependencies. ["foo@1.0.0", "bar@2.0.0", "baz@3.0.0"] ```

property name

name: string;

• Package name (e.g., foo, @foo/bar).

property overview

overview?: string;

• Package description extracted from the types file if a JSDoc comment with the @packageDocumentation tag is found.

property subpath

subpath: string;

• Package subpath selected when extracting the API (e.g., ., someFeature).

  See Also

  • ExtractPackageApiOptions.subpath

  • Node.js docs

property types

types?: string;

• Type declarations file, resolved from the selected subpath, that acts as the entrypoint for the package (e.g., index.d.ts).

property version

version: string;

• Package version number (e.g., 1.0.0).