Skip to content

re-js/provi

Repository files navigation

provi

npm version npm bundle size code coverage typescript supported

Minimalistic and cute Service Provider for server environment (node.js, bun) and for clients (browser, native).

  • You can use it at any place of your application without rewriting your application's architecture or other preparations or initializations.
  • Each dependency can be a class or function.
  • Feel free with your shared logic.

The service provider pattern - also called service locator pattern.

Advantages over Dependency Injection:

  • Zero configuration, easy to use everywhere whole your app.
  • Start-time and run-time dependency resolving, solving the circular dependency problem.
  • Smaller bundle size.

node.js or bun usage

import { provide } from "provi/server"

class Db { /* ... */ }

// Define dependencies using "provide" function
export class App {
  db = provide(Db)
  // ...
  start() {
    this.db.init()
    // ...
  }
}

browser or native usage

import { provide } from "provi/client"

class Auth {
  // user = sharedUser()
  // ...
  logout() {
    if (sharedUser().isAnonymous) return
    // ...
  }
}

export const sharedAuth = () => provide(Auth)

in both ways you can use plain javascript functions as dependency constructor

import { provide } from "provi/client"

const User = () => {
  // ...
  return {
    get isAnonymous() {
      return true;
    }
  }
}

export const sharedUser = () => provide(User)

Isolation of async scopes (only in node environment)

Run your app in isolated Service Provider scope. All instances cached for this will be isolated from all cached instances in other scopes. Useful for implementing SSR.

import { isolate } from "provi/ssr"

const html = await isolate(async () => {
  const { run } = provide(Logic); // Isolated instance of app logic
  await run();
  // ...
  return ReactDOMServer.renderToString(<App />);
});

Each isolated instance will be destroyed at the end of the isolated asynchronous function.

Installation

npm install provi

Enjoy your code!