Don't process functions beginning with underscores

2018-08-03 17:14:14 +02:00
parent b8c8258404
commit 0d3d9dad84
1 changed files with 11 additions and 2 deletions
--- a/packages/react-docs/src/utils/typedoc_utils.ts
+++ b/packages/react-docs/src/utils/typedoc_utils.ts
@@ -154,9 +154,18 @@ export const typeDocUtils = {

                case KindString.Function:
                    if (entity.flags.isExported) {
-                        const func = typeDocUtils._convertFunction(entity, docsInfo.sections, sectionName, docsInfo.id);
+                        const funcName = (entity as TypeDocNode).signatures[0].name;
+                        const isPublicFunc = !_.startsWith(funcName, '_');
+                        if (isPublicFunc) {
+                            const func = typeDocUtils._convertFunction(
+                                entity,
+                                docsInfo.sections,
+                                sectionName,
+                                docsInfo.id,
+                            );
                            docSection.functions.push(func);
                        }
+                    }
                    break;

                case KindString.Method: