unenv
Advanced tools
Changelog
Readme
unenv is a framework agnostic system that allows converting JavaScript code to be platform agnostic and working in any environment including Browsers, Workers, Node.js or pure JavaScript runtime.
# Using npm
npm i -D unenv
# Using yarn
yarn add --dev unenv
# Using pnpm
pnpm add -D unenv
Using env utility and built-in presets (and nodeless), unenv will provide an abstract configuration that can be used in building pipelines (rollup.js, webpack, etc.).
import { env, node, nodeless } from "unenv";
const { alias, inject, polyfill, external } = env(...presets);
nodeSuitable to convert universal libraries working in Node.js. (preset)
fetch APInodelessUsing this preset, we can convert a code that is depending on Node.js to work anywhere else.
unenv provides a replacement for all Node.js built-ins for cross-platform compatiblity.
unenv provides a replacement for common npm packages for cross platform compatibility.
| Package | Status | Source |
|---|---|---|
| npm/consola | Use native console | unenv/runtime/npm/consola |
| npm/cross-fetch | Use native fetch | unenv/runtime/npm/cross-fetch |
| npm/debug | Mocked with console.debug | unenv/runtime/npm/debug |
| npm/fsevents | Mocked | unenv/runtime/npm/fsevents |
| npm/inherits | Inlined | unenv/runtime/npm/inherits |
| npm/mime-db | Minimized | unenv/runtime/npm/mime-db |
| npm/mime | Minimized | unenv/runtime/npm/mime |
| npm/node-fetch | Use native fetch | unenv/runtime/npm/node-fetch |
| npm/whatwg-url | Use native URL | unenv/runtime/npm/whatwg-url |
import MockProxy from "unenv/runtime/mock/proxy";
console.log(MockProxy().foo.bar()[0]);
Above package doesn't work outside of Node.js and neither we need any platform specific logic! When aliasing os to mock/proxy-cjs, it will be auto mocked using a Proxy Object which can be recursively traversed like an Object, called like a Function, Iterated like an Array, or instantiated like a Class.
We use this proxy for auto mocking unimplemented internals. Imagine a package does this:
const os = require("os");
if (os.platform() === "windows") {
/* do some fix */
}
module.exports = () => "Hello world";
By aliasing os to unenv/runtime/mock/proxy-cjs, code will be compatible with other platforms.
Please check ./src/runtime to discover other polyfills.
MIT
FAQs
`unenv` is a framework-agnostic system that allows converting JavaScript code to be platform agnostic and work in any environment including Browsers, Workers, Node.js, or JavaScript runtime.
We found that unenv demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer 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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.