diff --git a/README.md b/README.md index 77d50ab..1ab2f96 100644 --- a/README.md +++ b/README.md @@ -872,17 +872,31 @@ require('ig-types/Set') ### `.unite(..)` - +Unite two sets and return the resulting set +```bnf +.unite() + -> +``` + +This is a shorthand for `new Set([..., ...])` ### `.intersect(..)` - +Intersect two sets and return the intersection set +```bnf +.untersect() + -> +``` ### `.subtract(..)` - +Subtract `` from set and return resulting set +```bnf +.subtract() + -> +``` ### `.sort(..)` @@ -1077,13 +1091,26 @@ require('ig-types/String') ### `.capitalize()` - +Capitalize the first character of a string +```bnf +.capitalize() + -> +``` ### `.indent(..)` - +Indent each line in `` by `` spaces +```bnf +.indent() + -> +``` +Indent/prepend each line in `` by the `` string +```bnf +.indent() + -> +``` ## `RegExp` @@ -1092,12 +1119,16 @@ require('ig-types/String') require('ig-types/RegExp') ``` - - ### `RegExp.quoteRegExp(..)` - +Quote regexp reserved characters in a string +```bnf +RegExp.quoteRegExp() + -> +``` + +This is mainly used to quote strings to be matched as-is within a regular expression. @@ -1111,10 +1142,6 @@ or var promise = require('ig-types/Promise') ``` - - - - ### Cooperative promises