Skip to content

ImportStatementContext

What ApiDocSettings.importStatement is told about the export whose import statement it builds.

Import:

import type { ImportStatementContext } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-settings';

Signature:

export interface ImportStatementContext

Properties

PropertyTypeDescription
defaultImportStatementstringThe statement the generator writes when no hook is set, e.g. import type { Alpha } from '@mnaoumov/typescript-lib/alpha';.
isTypeOnlybooleanWhether the export is a type only (an interface, a type alias or an enum), imported with import type.
kindstringThe export's kind, e.g. class, function, interface.
namestringThe export's name.
namespacestringThe export's namespace: its source path relative to the source folder, without its extension.

Links to this page: