Add doccomments

ksxnodemodules · Nov 9, 2018 · 7f0b59a · 7f0b59a
1 parent 74ad8b1
commit 7f0b59a
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/packages/typescript/cached-factorial/index.ts b/packages/typescript/cached-factorial/index.ts
@@ -1,5 +1,18 @@
 import { AdjadentNumberedCalculator } from 'cached-expression-shared-utils'
 
+/**
+ * Utilize [cached-expression](https://www.npmjs.com/package/cached-expression)
+ * to calculate multiple factorial numbers
+ *
+ * **Definition:**
+ * * 0! = 1! = 1
+ * * ∀ n ≥ 2: n! = n * (n - 1)!
+ *
+ * @example
+ * import CachedFactorial from 'cached-factorial'
+ * const { calculate } = new CachedFactorial()
+ * const result = [0, 1, 2, 3, 4, 5].map(calculate) // expect: [1, 1, 2, 6, 24, 120]
+ */
 class CachedFactorial extends AdjadentNumberedCalculator<number> {
   constructor () {
     super(

diff --git a/packages/typescript/cached-fibonacci/index.ts b/packages/typescript/cached-fibonacci/index.ts
@@ -1,5 +1,19 @@
 import { AdjadentNumberedCalculator } from 'cached-expression-shared-utils'
 
+/**
+ * Utilize [cached-expression](https://www.npmjs.com/package/cached-expression)
+ * to calculate fibonacci numbers
+ *
+ * **Definition:**
+ * * fib(0) = 0
+ * * fib(1) = 1
+ * * ∀ n ≥ 2: fib(n) = fib(n - 2) + fib(n - 1)
+ *
+ * @example
+ * import CachedFibonacci from 'cached-fibonacci'
+ * const { calculate } = new CachedFibonacci()
+ * const result = [0, 1, 2, 3, 4, 5].map(calculate) // expect: [0, 1, 1, 2, 3, 5]
+ */
 class CachedFibonacci extends AdjadentNumberedCalculator<number> {
   constructor () {
     super(x => {