docs(notnull): document notNull function

softwareventures · Apr 21, 2021 · 17e71e7 · 17e71e7
1 parent 590a5b2
commit 17e71e7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/index.ts b/index.ts
@@ -12,6 +12,10 @@ export function isNotNull<T>(value: T | null | undefined): value is T {
     return value != null;
 }
 
+/** Asserts that the specified value is neither null nor undefined, and
+ * returns it.
+ *
+ * @throws TypeError if the value is null or undefined */
 export function notNull<T>(value: T | null | undefined): T {
     if (value == null) {
         throw new TypeError(`value is ${String(value)}`);