Unexported variables are not removed

[njh7799]

• I have checked issues with bug label and found no duplicates

Expected Behavior

Not exported variables are not removed

Here's my code.

// typedoc.json
{
  "name": "Orion-facebook",
  "inputFiles": ["./src"],
  "mode": "file",
  "out": "docs",
  "excludeNotExported": true,
  "excludePrivate": true
}

// my code
...
const getPageData = async (date: string, from: string) => {
  return await ...;
};

const findRow = ($, to: string) => {
  const row = ...;
  return row;
};

const findCurrencyRate = ($, row) => {
  let currencyRate;
  ...
  return currencyRate;
};

const getCurrencyRate = async (date: string, from: string, to: string) => {
  const response = await getPageData(date, from);
  const html = response.data;
  const $ = cheerio.load(html);
  const row = findRow($, to);
  const currencyRate = findCurrencyRate($, row);
  return currencyRate;
};

const getNothing = async () => {};

export default getCurrencyRate;

I thought only getCurrencyRate would be generated at doc files since I'd set excludeNotExported to be true. However, the result was shown as below. The other non exported variables are not removed.

Actual Behavior

Steps to reproduce the bug

Environment

• Typedoc version:0.16.9
• Node.js version:12.14.0
• OS:mac

[xshkut]

I have the same problem. As temporary workaround you can tag your functions as @internal like

/**@internal */
const findRow = ($, to: string) => {
const row = ...;  
return row;  
};

Also --excludeNotExported works well with --mode modules, but it can affect your classes (change them to external modules and wrap them in double quotes)

[Gerrit0]

With --mode file this is expected behavior.

File mode tells TypeDoc that your source files should be treated as global script files, all declarations in them are implicitly exported.

You might be interested in the upcoming library mode, #1184, where TypeDoc builds documentation for only those declarations exported from the input file. You can try it out by installing typedoc@next and changing your typedoc.json file to be:

{
  "name": "Orion-facebook",
  "inputFiles": ["./src/index.ts"], // Note that this specifies a single file, since otherwise all files are treated as entry points.
  "mode": "library",
  "out": "docs",
  "excludeNotExported": true, // Doesn't do anything in library mode
  "excludePrivate": true
}