fix: add docs to satisfy() (#52)

unional · Nov 24, 2017 · 786c850 · 786c850
1 parent 4d1e797
commit 786c850
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/satisfy.ts b/src/satisfy.ts
@@ -2,6 +2,10 @@ export type SatisfyExpected<T> = {
   [P in keyof T]: Partial<SatisfyExpected<T[P]>> | RegExp | Function
 }
 
+/**
+ * Check if `actual` satisfies criteria in `expected`.
+ * @param expected All properties can be a value which will be compared to the same property in `actual`, RegExp, or a predicate function that will be used to check against the property.
+ */
 export function satisfy<
   Actual,
   Expected extends Partial<SatisfyExpected<Actual>>>(actual: Actual, expected: Expected) {