reject private methods from docs

smartprocure · Apr 30, 2023 · 2249668 · 2249668
1 parent 3068c1f
commit 2249668
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/scripts/generate-docs.js b/scripts/generate-docs.js
@@ -24,6 +24,7 @@ let getDocs = async () => {
   let jsDocToJson = _.flow(
     _.reject('undocumented'),
     _.reject({ kind: 'module' }),
+    _.reject({ access: 'private' }),
     _.filter('name'),
     _.map(async (x) => {
       let path = `${x.meta.path}/${x.meta.filename}`

diff --git a/src/object.js b/src/object.js
@@ -536,6 +536,8 @@ export let updatePaths = _.curry((transforms, data) =>
 
 /**
  * Calls a function or defaults to isEqual, used internally by _matchesBy
+ * 
+ * @private
  * @typescript (fn: (x: any) => any | any, value: any)
  */
 let callOrCompare = (fn, value) =>
@@ -544,6 +546,7 @@ let callOrCompare = (fn, value) =>
 /**
  * Internal function used by `matchesBy` and `matchesBySome`
  *
+ * @private
  * @typescript (combiner: (values: boolean[]) => boolean, criteria: object, object: object)
  */
 let _matchesBy = _.curry((combiner, criteria, object) =>