Skip to content

Commit

Permalink
Adding inline documentation for clean-deep
Browse files Browse the repository at this point in the history
  • Loading branch information
mikaello committed Apr 2, 2019
1 parent 90930cf commit abe8a15
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/CleanDeep.rei
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
/** [bs-clean-deep] is bindings for {{: https://github.com/nunofgs/clean-deep } [clean-deep]},
a library for removing empty or nullable values from javascript objects.
[clean-deep] uses lodash ([isempty] and [isplainobject]) in addition to
checking for empty and nullable values to perform the actual cleaning of
JS-objects.
*/

/** Removing empty or nullable values from javascript objects. Set any of the
parameters to [false] to exclude that type from being cleaned.
*/
let cleanDeep:
(
~emptyArrays: bool=?,
Expand Down

0 comments on commit abe8a15

Please sign in to comment.