@pi0/unenv v1.9.0-rc.2

unenv

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.

Install

# Using npm
npm i -D unenv

# Using yarn
yarn add --dev unenv

# Using pnpm
pnpm add -D unenv

Usage

Using env utility and built-in presets, unenv will provide an abstract configuration that can be used in building pipelines (rollup.js, webpack, etc.).

import { env } from "unenv";

const { alias, inject, polyfill, external } = env({}, {}, {});

Note: You can provide as many presets as you want. unenv will merge them internally and the right-most preset has a higher priority.

node preset

Suitable to convert universal libraries working in Node.js.

• Add supports for global fetch API
• Set Node.js built-ins as externals

import { env, nodeless } from "unenv";

const envConfig = env(node, {});

(view node preset source)

nodeless preset

Suitable to transform libraries made for Node.js to run in other JavaScript runtimes.

import { env, nodeless } from "unenv";

const envConfig = env(nodeless, {});

(view nodeless preset source)

deno preset

Note: This preset is experimental and behavior can change!

This preset can be used to extend nodeless to use Deno's Node.js API Compatibility (docs, docs).

import { env, nodeless, deno } from "unenv";

const envConfig = env(nodeless, deno, {});

(view deno preset source)

Built-in Node.js modules

unenv provides a replacement for all Node.js built-ins for cross-platform compatibility.

npm packages

unenv provides a replacement for common npm packages for cross platform compatibility.

Auto-mocking proxy

import MockProxy from "unenv/runtime/mock/proxy";

console.log(MockProxy().foo.bar()[0]);

The 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, the code will be compatible with other platforms.

Other polyfills

To discover other polyfills, please check ./src/runtime.

License

MIT