fix: export helper functions to match documentation (#9)

jeskew · web-flow · commit 987b95c00d8a · 2018-07-22T11:39:34.000-07:00
diff --git a/src/index.ts b/src/index.ts
@@ -16,6 +16,8 @@ export * from './flatMap';
 export * from './flatten';
 export * from './includes';
 export * from './interleave';
+export * from './isIterable';
+export * from './iteratorFromIterable';
 export * from './map';
 export * from './merge';
 export * from './range';
diff --git a/src/isIterable.ts b/src/isIterable.ts
@@ -1,7 +1,17 @@
+/**
+ * Determines if the provided value adheres to the AsyncIterable protocol.
+ *
+ * @param arg Any value
+ */
 export function isAsyncIterable<T>(arg: any): arg is AsyncIterable<T> {
     return Boolean(arg) && typeof arg[Symbol.asyncIterator] === 'function';
 }
 
+/**
+ * Determines if the provided value adheres to Iterable protocol.
+ *
+ * @param arg Any value
+ */
 export function isSyncIterable<T>(arg: any): arg is Iterable<T> {
     return Boolean(arg) && typeof arg[Symbol.iterator] === 'function';
 }
diff --git a/src/iteratorFromIterable.ts b/src/iteratorFromIterable.ts
@@ -1,5 +1,14 @@
 import { isAsyncIterable } from './isIterable';
 
+/**
+ * Extracts the underlying synchronous or asynchronous iterator from a
+ * synchronous or asynchronous iterable, respectively.
+ *
+ * If the provided value adheres to both the Iterable and AsyncIterable
+ * protocols, its asynchronous interface will be used.
+ *
+ * @param iterable A synchronous or asynchronous iterable.
+ */
 export function iteratorFromIterable<T>(
     iterable: Iterable<T>|AsyncIterable<T>
 ): Iterator<T>|AsyncIterator<T> {
