A utility belt that normalizes and wraps Ramda and Lodash/FP. In addition, some other "adjunct" methods are included that solve common patterns. The order of precedence is: Does it exist in Ramda? Does it exist in Lodash/FP? Then it must be custom (in src/omnibelt). That means that you can deconstruct methods from any of those three from the omnibelt exported object.
const {
merge, converge, toString, // Ramda
isNull, throttle, camelCase, // Lodash
isPopulatedString, // Omnibelt
} = require('omnibelt');
... I've only grouped them for demonstration purposes, please don't do that in your code.
yarn run test
Deconstruction
const { isPopulatedString, toLower } = require('omnibelt');
const foo = 'foo';
if (!isPopulatedString(foo)) {
throw new Error('DANGER');
} else {
return toLower(foo);
}
Namespaced - Use O by convention
const O = require('omnibelt');
const foo = 'foo';
if (!O.isPopulatedString(foo)) {
throw new Error('DANGER');
} else {
return O.toLower(foo);
}
method :: Type -> Type stuff? It's Hindley-Milner Notation.omnibelt methods are collocated with the method's definition. When contributing a new function, please provide docs (and tests).JSDoc definitions at the top of each of the omnibelt module functions should be kept up to date and are meant to describe the usage of each function in detail. From these doc comments, a documentation site is generated using the Docdash template.
You can open the docs locally by running the following npm script on a mac. In general (and for non-mac machines), you can simply opening docs/index.html in a browser.
yarn run docs
You can also see documentation for the latest tag on the GitHub pages for this project.
https://losant.github.io/omnibelt/
Docs should be generated when a new version is tagged and pushed. Ramda and Lodash docs are autogenerated as part of a pre build step and you shouldn't have to interface with manually updating which methods are being pulled in. Docs are committed to docs and are served as a GitHub page whenever master is updated.
yarn run docs:build
git add -A
git commit -m "Regenerated docs"
git co develop
git fetch
git pull
# Update `package.json` version
# Update `README` changelog, naming the latest version
yarn run docs:build
git add -A
git commit -m "version bump and doc regeneration"
git push
git checkout master
git merge develop
git release vX.X.X
Below should serve as an "upgrade guide" jumping off point as you are migrating projects to newer versions of this package. Ideally, interface changes will be called out specifically and one should not have to go sifting through git diffs to discern what changed.
3.1.1
size (Lodash)@rjhilgefort/export-dir.import { size } from 'omnibelt'.3.1.0
18.16.00.29.0 (note in this version of ramda they release a function called isNotNil, omnibelt has a isNotNil function already so that ramda function is not included in this library)3.0.0
16.17.10.28.0 (note in this version of ramda they release a function called count, omnibelt has a count function already so that ramda function is not included in this library)1.5.029.3.110.1.08.0.229.3.14.0.013.0.32.1.0
mapP waits for all promises to complete and then throw the first error if foundmapParallelLimitP does not continue to run promises once a promise has erroredresolveProps waits for all promises to complete and then throws the first error if found2.0.2
14.16.14.17.211.4.34.7.76.0.026.6.311.0.02.0.1
mapSerialP14.15.026.6.226.6.210.5.12.0.0
ramda bumped to 0.27.1lodash bumped to 4.17.20@rjhilgefort/export-dir bumped to 2.0.01.3.3
ramda bumped to 0.27.0@rjhilgefort/export-dir bumped to 1.1.31.3.2
lodash bumped to 4.17.15string-format bumped to 2.0.0timeoutP1.3.1
isPlainObject1.3.0
lodash bumped to 4.17.11evolveArray, Ramda evolve now supports arrays with evolvestringify-object bumped to 3.3.0allSettledPforEachSerialPmapParallelLimitPevolveArray
evolve now supports arrays1.2.0
git remote set-url origin git@github.com:Losant/omnibelt.gitlodash bumped to 4.17.10string-format bumped to 1.0.0mapIndexed1.1.9
mapPtimeout -> timeoutP1.1.8
1.1.7
ensureEndsWith1.1.6
testHarness and the like, no longer assume that expect is available in your environment through jest. Instead, you must pass expect in as a dependency. See this issue for more info.1.3.2equalsAnycontainsAll1.1.5
testHarnesstestCasesevolveArray.1.1.4
0.25.0. Upgrade guide here.tap has been omitted from Ramda and implemented in this project to work around new version.toInteger (Lodash)testHarness: Now is not exported as part of this library and is only used internallytest* methods have been moved to test/ and are only for internal use.testHarness has been updated with a new interface. testHarnessUnary is still around for backwards compatibility.testCases now exists to eliminate a common pattern when using testHarness.1.1.3
ramda/lodash.forEach: Note that forEachObjIndexed still comes from ramda (behaves as expected)indexBy from Ramda has been omitted in favor of keyByparseInt from Lodash has been omitted because it conflicts poorly with nativedotPathdotPathOreqDotPathseqDotPathsShallowequalsShallowtoPlainObject (Lodash)toNumber (Lodash)mapFilterfilterMapmapRejectNilrejectNilMapdefernoopAsyncresolvePropstimeout1.1.2
keyByWith1.1.1
sleeproundwithin1.1.0
clampPositivecountintersectAnyupperCamelCaseflattenShallow
R.unnest (though flattenShallow is a bit more semantic).1.0.12
ramda back down to 0.24.1.1.0.11
git remote set-url origin git@github.com:Losant/omnibelt.gitnonePasseqPathsensureStartsWiththrottleLeadingthrottleTrailingflip now comes from lodash/fpthrottle is now "custom" and accepts 3 arguments (still curried)debounce is now "custom" and accepts 3 arguments (still curried)1.0.10
containsAnyisNotNiltoStringtoLowertoUppertrimsplit1.0.9
jsonParseSafethunkifytryCatchSafe1.0.8
fpThrow now accepts an Error object and will rethrow when passed.1.0.7
allEqualargsToObjcontainsAlldefaultToStrictensureArrayequalsAnyevolveArrayflattenShallowfpThrowisNilOrEmptyisNotEmptyisNotlistmergeSpecpropOrStrictstringifyupdateKeysupdateKeysWithupdateKeyPaths1.0.6
formatisPopulatedStringmergeWithArraysreplaceAllstringToBooleantraceREADME.md documentation can be found at the rood of the repo.FAQs
A utility belt that normalizes and wraps `Ramda` and `Lodash/FP`.
The npm package omnibelt receives a total of 233 weekly downloads. As such, omnibelt popularity was classified as not popular.
We found that omnibelt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.