@jsdocs-io/extractor/dist/extract-type-alias.js

The API extractor for npm packages powering jsdocs.io

import { docs } from "./docs.js";
import { formatSignature } from "./format-signature.js";
import { id } from "./id.js";
import { sourceFilePath } from "./source-file-path.js";
export async function extractTypeAlias(containerName, exportName, declaration) {
    return {
        kind: "type",
        id: id(containerName, "+type", exportName),
        name: exportName,
        docs: docs(declaration),
        file: sourceFilePath(declaration),
        line: declaration.getStartLineNumber(),
        signature: await typeAliasSignature(declaration),
    };
}
async function typeAliasSignature(declaration) {
    // Using `declaration.getType().getText(declaration);` returns the expanded/resolved type.
    // However this causes:
    // - inline imports like `import('...').SomeType` to appear in the signature
    // - types can become really long in some cases as they are expanded by the compiler
    // - format flags like `TypeFormatFlags.NoTruncation | TypeFormatFlags.UseAliasDefinedOutsideCurrentScope`
    //   seem to be ignored or cause local types to be resolved to their name like `type Foo = Foo;`
    // For these reasons we simply get the type alias text as written by authors.
    // See:
    // - https://github.com/dsherret/ts-morph/issues/453#issuecomment-427405736
    // - https://twitter.com/drosenwasser/status/1289640180035403776
    const signature = declaration.getText();
    return await formatSignature("type", signature);
}