Skip to content

Commit 20e7861

Browse files
jkelvieblakeembrey
authored andcommitted
Add --excludePrivate option (#293)
1 parent 22ccb66 commit 20e7861

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ in order to change the behaviour of TypeDoc.
7171
Define a pattern for files that should be considered being external.
7272
* `--excludeExternals`<br>
7373
Prevent externally resolved TypeScript files from being documented.
74+
* `--excludePrivate`<br>
75+
Prevent private members from being included in the generated documentation.
76+
7477

7578
#### TypeScript compiler
7679
* `--module <commonjs, amd, system or umd>`<br>

src/lib/converter/nodes/class.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,19 @@ import {Reflection, ReflectionKind, DeclarationReflection} from "../../models/in
44
import {createDeclaration} from "../factories/index";
55
import {Context} from "../context";
66
import {Component, ConverterNodeComponent} from "../components";
7+
import {ParameterType} from "../../utils/options/declaration";
8+
import {Option} from "../../utils/component";
79

810

911
@Component({name:'node:class'})
1012
export class ClassConverter extends ConverterNodeComponent<ts.ClassDeclaration>
1113
{
14+
@Option({
15+
name: "excludePrivate",
16+
help: 'Ignores private variables and methods',
17+
type: ParameterType.Boolean
18+
})
19+
excludePrivate:boolean;
1220
/**
1321
* List of supported TypeScript syntax kinds.
1422
*/
@@ -36,7 +44,12 @@ export class ClassConverter extends ConverterNodeComponent<ts.ClassDeclaration>
3644
context.withScope(reflection, node.typeParameters, () => {
3745
if (node.members) {
3846
node.members.forEach((member) => {
39-
this.owner.convertNode(context, member);
47+
const privateMember = (member.flags & ts.NodeFlags.Private) > 0;
48+
const exclude = this.excludePrivate ? privateMember : false;
49+
50+
if (!exclude) {
51+
this.owner.convertNode(context, member);
52+
}
4053
});
4154
}
4255

0 commit comments

Comments
 (0)