npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

common-proxy

v0.0.7

Published

Utility methods to help manage and expose nx plugins

Downloads

23

Readme

common-proxy

Conveniently expose ESM-backed methods as a syncronously available (commonjs) async method.

npm package License

Contents

Introduction

ESM methods import asyncronously. If your codebase is all ESM, then that is easy to work with!

But sometimes you have to support CommonJS, either because you are developing a plugin or existing codebase hasn't been migrated to ESM yet.

common-proxy is a CommonJs package that can be provided with your ESM import and syncronously expose the main default export as a promise-returning method.

Usage

How it used t work:

// my-module.mts
export const sayHello = (name: string): void => `hello ${name}`;

export default function add(x: number, y: number): number {
    return x + y;
};
// my-old-script.cts
// Error! Cannot `require` an ESM package
import add from './my-module';

(async () => {
    // Works... but requires, and isn't accessible elsewhere
    const { sayHello } = await import('./my-module');
    sayHello('Jacob');
})();

How it works with common-proxy

// my-module.cts
import { commonProxy } from 'common-proxy';

const imported = import('./my-module.mjs');

export default commonProxy(imported);
export const sayHello = imported.then(mod => mod.sayHello);
// my-new-script.cts
import add, { sayHello } from './my-module.cjs';

// Both return promises!
const sum: Promise<number> = add(1, 2);
sayHello('Jacob');

API

commonProxy

Takes a Promise of a function, and syncronously returns a function that has the same signature and returns a promise that eventually resolves with the real result from the true function.

If the parameter is actually a module with a default property (the way import(<package>) exposes a default export), the method from default import will be used. See default-import for more context.

Any other methods should be passed directly. This can be achieved with promise chaining import(<package>).then(mod => mod.methodName).