Search terms type parameter as plain text destructe

How can I get type parameter as plain text? about typedoc HOT 3 CLOSED

Mizugorou commented on June 7, 2024

How can I get type parameter as plain text?

from typedoc.

Comments (3)

Gerrit0 commented on June 7, 2024

For this you'd have to write a custom plugin to overwrite the type with a stringified version, here's an example of how to do that for parameters.

$ npx typedoc src/gh2472.ts --plugin ./path/to/plugin.mjs

// @ts-check
import td from "typedoc";

/** @param {td.Application} app */
export function load(app) {
    /** @type {Map<td.ParameterReflection, td.SomeType>} */
    const replacements = new Map();

    app.converter.on(td.Converter.EVENT_CREATE_PARAMETER, replaceTypesWithStrings);

    app.converter.on(td.Converter.EVENT_RESOLVE_BEGIN, () => {
        for (const [param, type] of replacements) {
            param.type = type;
        }
        replacements.clear();
    });

    /**
     * @param {td.Context} context
     * @param {td.ParameterReflection} reflection
     * @param {td.TypeScript.Node?} node
     */
    function replaceTypesWithStrings(context, reflection, node) {
        const symbol = context.project.getSymbolFromReflection(reflection);
        if (!symbol) return;

        const type = context.checker.typeToString(context.checker.getTypeOfSymbol(symbol));
        replacements.set(reflection, new td.UnknownType(type));
    }
}

from typedoc.

Mizugorou commented on June 7, 2024

Great one! Look like it need to do custom callback to each places.
Could I ask more? I want this results apply to all places such as 'return', not just parameter. Could you another guide me? Or have any more detail document for this?

  // for example. I want to get results as K[] and T[]
  public myFunction(params: K[]): T[] {
     ...
     return 
  }

from typedoc.

Gerrit0 commented on June 7, 2024

You'll have to add listeners for the other CREATE events on the converter, and replace the type field on those too: https://typedoc.org/api/classes/Converter.html#EVENT_CREATE_DECLARATION is the big one, but there's also one for parameters and signatures

from typedoc.

Recommend Projects