Mark private functions private

hildjj · Jul 2, 2023 · d20118a · d20118a
1 parent 688fc9d
commit d20118a
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 76 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Basura.html b/docs/classes/Basura.html
diff --git a/docs/types/BasuraGenerator.html b/docs/types/BasuraGenerator.html
@@ -35,7 +35,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/hildjj/basura/blob/d93b175/lib/index.js#L87">index.js:87</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/hildjj/basura/blob/688fc9d/lib/index.js#L87">index.js:87</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/docs/types/BasuraRandBytes.html b/docs/types/BasuraRandBytes.html
@@ -39,7 +39,7 @@ <h5><span class="tsd-kind-parameter">reason</span>: <span class="tsd-signature-t
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Buffer</span></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/hildjj/basura/blob/d93b175/lib/index.js#L76">index.js:76</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/hildjj/basura/blob/688fc9d/lib/index.js#L76">index.js:76</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/lib/data.js b/lib/data.js
@@ -1,7 +1,7 @@
 import {Buffer} from 'buffer'
 import {UnicodeTrie} from '@cto.af/unicode-trie'
 
-export const generatedDate = new Date('2023-07-01T21:53:27.470Z')
+export const generatedDate = new Date('2023-07-02T05:19:40.130Z')
 export const Trie = new UnicodeTrie(Buffer.from(
   `AAgOAAAAAQAdFgAAW79bMSIJaU1qREUrEZS/SrDhUF1Bf5jSr7Qt78H5xQWGlljE8+y/GDAJ
    twylHYRTOzsjgIsBoDZjeJ9XeUqhbaKLg4O3Cw+Dpv7LuML1c+FfphdIp+knnXZw8xYySCeu

diff --git a/lib/index.js b/lib/index.js
@@ -285,6 +285,7 @@ export class Basura {
    *   to generate up to stringLength bytes
    * @param {string} [reason='unspecified'] - reason for generation
    * @return {bigint} the random number
+   * @private
    */
   _randUBigInt(bytes = -1, reason = 'unspecified') {
     const len = (bytes === -1) ?
@@ -300,6 +301,7 @@ export class Basura {
    *
    * @param {string} [reason='unspecified'] - reason for generation
    * @return {number} the random number
+   * @private
    */
   _random01(reason = 'unspecified') {
     const buf = this._randBytes(8, `_random01,${reason}`)
@@ -326,6 +328,7 @@ export class Basura {
    *   generated
    * @param {string} [reason='unspecified'] - reason for generation
    * @return {number} the random number
+   * @private
    */
   _randomGauss(mean, stdDev, reason = 'unspecified') {
     // See: https://stackoverflow.com/a/60476586/8388 or
@@ -354,6 +357,7 @@ export class Basura {
    * @param {number} num - one more than the maximum number generated
    * @param {string} [reason='unspecified'] - reason for generation
    * @return {number} the random number
+   * @private
    */
   _upto(num, reason = 'unspecified') {
     if (num === 0) {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -117,15 +117,17 @@ export class Basura {
      *   to generate up to stringLength bytes
      * @param {string} [reason='unspecified'] - reason for generation
      * @return {bigint} the random number
+     * @private
      */
-    _randUBigInt(bytes?: number, reason?: string): bigint;
+    private _randUBigInt;
     /**
      * Generate a random number (0,1].
      *
      * @param {string} [reason='unspecified'] - reason for generation
      * @return {number} the random number
+     * @private
      */
-    _random01(reason?: string): number;
+    private _random01;
     /**
      * Generate a random number with close to gaussian distribution.
      * Uses the polar method for normal deviates, which generates two
@@ -138,16 +140,18 @@ export class Basura {
      *   generated
      * @param {string} [reason='unspecified'] - reason for generation
      * @return {number} the random number
+     * @private
      */
-    _randomGauss(mean: number, stdDev: number, reason?: string): number;
+    private _randomGauss;
     /**
      * Generate a random positive integer less than a given number.
      *
      * @param {number} num - one more than the maximum number generated
      * @param {string} [reason='unspecified'] - reason for generation
      * @return {number} the random number
+     * @private
      */
-    _upto(num: number, reason?: string): number;
+    private _upto;
     /**
      * Pick an arbitrary element from the specified array
      *