Socket
Socket
Sign inDemoInstall

modern-node-polyfills

Package Overview
Dependencies
30
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    modern-node-polyfills

modern polyfills for node native modules based on jspm-core


Version published
Weekly downloads
21K
increased by5.28%
Maintainers
1
Install size
5.11 MB
Created
Weekly downloads
 

Readme

Source

modern-node-polyfills

A way to enable using Node native modules in non-node (Browser, Cloudflare, Deno, ...) environemnts with modern polyfills from JSPM.

Here are the modules that are supported in modern-node-polyfills.

Example

import { polyfillPath } from "modern-node-polyfills";

console.log(await polyfillPath("fs")) 
// /home/bagher/project/@jspm/core/nodelibs/browser/fs.js

polyfillPath

This function returns the path of the requested module.

await polyfillPath("fs");
await polyfillPath("node:fs") // Modules can have the `node` prefix

polyfillContent

It returns the bundled content of a specific node module instead of a path.

console.log(await polyfillContent("fs"));
// the bundled source of `fs`

inject

This function tries to do the work of @rollup/plugin-inject plugin! but it also adds a new option called expressions which is for replacing javascript expressions like __filename.

console.log(await inject("console.log(__filename);", {
  // replaces every global __filename with "/"
  expressions: { __filename: "/" },
  modules: {
    // replaces every global `Buffer` with the imported `Buffer` from the polyfill buffer
    Buffer: [await polyfillPath("buffer"), "Buffer"],
  }
}))
// logs `console.log("/")`

polyfillGlobals

A way to polyfill all global node expressions, in this case, process, Buffer, global, setImmediate, clearImmediate, __dirname and __filename. It's possible to customize the __filename and __dirname values in the second argument of this function.

console.log(await polyfillGlobals(`
    console.log(global);
    console.log(process);
    console.log(Buffer);
    console.log(setImmediate);
    console.log(clearImmediate);
`))
// shows the polyfilled content

As a third argument, it's possible to change the path of those global polyfills or even disable them using null.

const content = await polyfillGlobals(
	`
	console.log(global)
	console.log(process);
	console.log(Buffer);
	console.log(setImmediate);
	console.log(clearImmediate);
`,
	{},
	{
		process: "/here/process.js",
		Buffer: null,
		global: null,
		setImmediate: null,
		clearImmediate: null,
	}
);

Contribution

Feel free to let me know what you need for this package or what issue you have, I'd be happy!

Keywords

FAQs

Last updated on 12 Jun 2023

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc