feat: Add typescript type definitions

Author: justinvdm

index.d.ts

@@ -3,7 +3,7 @@ exports.oneOf = require('./oneOf')
 exports.tuple = require('./tuple')
 
 exports.int = require('./int')
+exports.float = require('./float')
 exports.word = require('./word')
 exports.bool = require('./bool')
 exports.datestr = require('./datestr')
-exports.float = require('./float')

index.js

@@ -3,7 +3,7 @@ export { default as oneOf } from './oneOf'
 export { default as tuple } from './tuple'
 
 export { default as int } from './int'
+export { default as float } from './float'
 export { default as word } from './word'
 export { default as bool } from './bool'
 export { default as datestr } from './datestr'
-export { default as float } from './float'

index.mjs

@@ -0,0 +1,12 @@
+import { expectType } from 'tsd'
+import { Input, int, word, tuple, oneOf } from '.'
+
+// ## tuple
+// ### function items
+expectType<[number]>(tuple(23, [int]))
+expectType<[number, string]>(tuple(23, [int, word]))
+expectType<[number, string, number]>(tuple(23, [int, word, int]))
+
+// ## currying
+expectType<(input: Input) => [number]>(tuple([int]))
+expectType<(input: Input) => number>(oneOf([2, 3]))

index.test-d.ts

@@ -2,4 +2,4 @@
 
 Generate fake data deterministically from a given input
 
-_Docs and type definitions coming soon_
+_Docs coming soon_

internal/displayType.js

@@ -1,19 +1,6 @@
 const tap = require('tap')
 const { tuple } = require('..')
 
-tap.test('array items', t => {
-  const result = tuple(23, [[(v, suffix) => [v, suffix].join(''), '!']])
-
-  t.match(result, [/^\d+!$/])
-  t.end()
-})
-
-tap.test('invalid items', t => {
-  t.throws(() => tuple(23, [2]))
-  t.throws(() => tuple(23, [[3]]))
-  t.end()
-})
-
 tap.test('currying', t => {
   const fn = v => `${v}!`
   t.deepEquals(tuple(23, [fn]), tuple([fn])(23))

internal/typeOf.js

@@ -1,48 +1,25 @@
 var hash = require('./hash')
-var displayType = require('./internal/displayType')
 
 module.exports = function tuple(a, b) {
   return a != null && b != null ? tupleMain(a, b) : tupleCurried(a)
 }
 
-function tupleMain(inputs, items) {
+function tupleMain(inputs, fns) {
   var id = hash(inputs)
-  var n = items.length
+  var n = fns.length
   var i = -1
   var results = []
 
   while (++i < n) {
     id = hash(id)
-    results.push(callItem(items[i], id))
+    results.push(fns[i](id))
   }
 
   return results
 }
 
-function callItem(item, id) {
-  var fn
-
-  if (typeof item === 'function') {
-    return item(id)
-  }
-
-  if (Array.isArray(item)) {
-    fn = item[0]
-
-    if (typeof fn === 'function') {
-      return item[0].apply(null, [id].concat(item.slice(1)))
-    }
-  }
-
-  throw new Error(
-    'tuple() was given an array item of type ' +
-      displayType(item) +
-      '. Each item in the array given to tuple() must either be a function, or an array with a function as its first item.'
-  )
-}
-
-function tupleCurried(items) {
+function tupleCurried(fns) {
   return function tupleCurriedFn(inputs) {
-    return tupleMain(inputs, items)
+    return tupleMain(inputs, fns)
   }
 }