Thanks to visit codestin.com
Credit goes to github.com

Skip to content

πŸ’‰πŸ“¦ Pure functional programming based dependency injection (DI) for TypeScript, without any classes, inspired by uber/fx in Go

License

Notifications You must be signed in to change notification settings

moeru-ai/injeca

Repository files navigation

Injeca

Pure functional programming (means no class and extra wrappers and containers) based dependency injection with application lifecycle management.

Heavily inspired by uber/fig and uber/dig in Golang ecosystem.

npm version npm downloads bundle JSDocs License

Installation

npm install injeca
pnpm add injeca
bun add injeca
ni injeca
yarn add injeca

Basic usage

injeca ships with a global singleton container exposed as injeca. You can register providers, declare their dependencies, and run invocations once everything is ready.

import { createServer } from 'node:http'

import { injeca, lifecycle } from 'injeca'

// Providers return a value once and are cached inside the container.
const config = injeca.provide('config', () => ({ port: 3000 }))

const server = injeca.provide({
  dependsOn: { config, lifecycle },
  async build({ dependsOn }) {
    const { config, lifecycle } = dependsOn
    const app = createServer()

    lifecycle.appHooks.onStart(() => app.listen(config.port))
    lifecycle.appHooks.onStop(() => app.close())

    return app
  },
})

injeca.invoke({
  dependsOn: { server },
  async callback({ server }) {
    // eslint-disable-next-line no-console
    console.log('HTTP server ready:', await server.address())
  },
})

await injeca.start()

process.once('SIGINT', async () => {
  await injeca.stop()
})

Warning

injeca implements singleton / cached dependencies by default

This means every value returned by build will be stored and build will only got called once.

If build returns a function, that function is cached (not the result of calling it). This is useful for lazy dependencies, "getters", or wrappers for singleton, but it also means any side effects inside the returned function will run on every call.

If you want the returned function to be reusable (e.g. a single window), create the reusable closure once inside build, and return a wrapper that calls it:

const settingsWindow = injeca.provide('windows:settings', {
  dependsOn: { widgetsManager },
  build: ({ dependsOn }) => {
    const getWindow = setupReusableSettingsWindow(dependsOn) // created once
    return async () => await getWindow() // can be called many times
  },
})

Avoid recreating the reusable function inside the returned function, otherwise each call starts from a fresh cache and can create duplicate resources.

Manual containers

If you need multiple containers (for tests or per-request scopes), create them explicitly and pass the container reference into provide, invoke, start, and stop.

import { createContainer, invoke, provide, start, stop } from 'injeca'

const container = createContainer()

const token = provide(container, 'token', () => crypto.randomUUID())

invoke(container, {
  dependsOn: { token },
  // eslint-disable-next-line no-console
  callback: ({ token }) => console.log('token', token),
})

await start(container)
await stop(container)

License

MIT

About

πŸ’‰πŸ“¦ Pure functional programming based dependency injection (DI) for TypeScript, without any classes, inspired by uber/fx in Go

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  
  •