Skip to content

๐ŸŽฃ๐Ÿ”— Mimikrook: Awaitable hooks for seamless code enhancement! ๐Ÿ’ช๐Ÿ’ก Boost your development with the power of hooks. ๐Ÿš€

License

Notifications You must be signed in to change notification settings

nyxblabs/mimikrook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

11 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

cover npm version npm downloads bundle License

๐Ÿช„ Mimikrook

๐ŸŽฃ๐Ÿ”— Mimikrook: Awaitable hooks for seamless code enhancement! ๐Ÿ’ช๐Ÿ’ก Boost your development with the power of hooks. ๐Ÿš€

๐Ÿ“ฆ Install:

Using yarn:

# nyxi
nyxi mimikrook

# pnpm
pnpm add mimikrook

# npm
npm i mimikrook

# yarn
yarn add mimikrook

๐Ÿ“˜ Usage

Method ๐Ÿ…ฐ๏ธ: Create a mimikrook instance:

import { createHooks } from 'mimikrook'

// Create a mimikrook instance
const hooks = createHooks()

// Hook on 'hello'
hooks.hook('hello', () => { console.log('Hello World') })

// Call 'hello' hook
hooks.callHook('hello')

Method ๐Ÿ…ฑ๏ธ: Extend your base class from Mimikrook:

import { Mimikrook } from 'mimikrook'

export default class FooLib extends Mimikrook {
   constructor() {
      // Call to parent to initialize
      super()
      // Initialize Mimikrook with custom logger
      // super(consola)
   }

   async someFunction() {
      // Call and wait for `hook1` hooks (if any) sequential
      await this.callHook('hook1')
   }
}

๐Ÿ”Œ Inside plugins, register for any hook:

const lib = new FooLib()

// Register a handler for `hook2`
lib.hook('hook2', async () => { /* ... */ })

// Register multiply handlers at once
lib.addHooks({
   hook1: async () => { /* ... */ },
   hook2: []
})

๐Ÿ—‘๏ธ Unregistering hooks:

const lib = new FooLib()

async function hook0() { /* ... */ }
async function hook1() { /* ... */ }
async function hook2() { /* ... */ }

// The hook() method returns an "unregister" function
const unregisterHook0 = lib.hook('hook0', hook0)
const unregisterHooks1and2 = lib.addHooks({ hook1, hook2 })

/* ... */

unregisterHook0()
unregisterHooks1and2()

// or

lib.removeHooks({ hook0, hook1 })
lib.removeHook('hook2', hook2)

๐Ÿ”‚ Triggering a hook handler once:

const lib = new FooLib()

const unregister = lib.hook('hook0', async () => {
   // Unregister as soon as the hook is executed
   unregister()

   /* ... */
})

๐Ÿซ Mimikrook class

๐Ÿ—๏ธ constructor()

๐Ÿช hook (name, fn)

Register a handler for a specific hook. fn must be a function.

Returns an unregister function that, when called, will remove the registered handler.

๐Ÿ•’ hookOnce (name, fn)

Similar to hook but unregisters hook once called.

Returns an unregister function that, when called, will remove the registered handler before first call.

๐Ÿ“ addHooks(configHooks)

Flatten and register hooks object.

๐Ÿ’กExample:

mimikrook.addHooks({
   test: {
      before: () => {},
      after: () => {}
   }
})

This registers test:before and test:after hooks at bulk.

Returns an unregister function that, when called, will remove all the registered handlers.

๐Ÿ“ž async callHook (name, ...args)

Used by class itself to sequentially call handlers of a specific hook.

๐Ÿ“ž callHookWith (name, callerFn)

If you need custom control over how hooks are called, you can provide a custom function that will receive an array of handlers of a specific hook.

callerFn if a callback function that accepts two arguments, hooks and args:

  • hooks: Array of user hooks to be called
  • args: Array of arguments that should be passed each time calling a hook

โš ๏ธ deprecateHook (old, name)

Deprecate hook called old in favor of name hook.

โš ๏ธ deprecateHooks (deprecatedHooks)

Deprecate all hooks from an object (keys are old and values or newer ones).

๐Ÿ—‘๏ธ removeHook (name, fn)

Remove a particular hook handler, if the fn handler is present.

๐Ÿ—‘๏ธ removeHooks (configHooks)

Remove multiple hook handlers.

๐Ÿ’ก Example:

async function handler() { /* ... */ }

mimikrook.hook('test:before', handler)
mimikrook.addHooks({ test: { after: handler } })

// ...

mimikrook.removeHooks({
   test: {
      before: handler,
      after: handler
   }
})

๐Ÿ—‘๏ธ removeAllHooks

Remove all hook handlers.

โฎ๏ธ beforeEach (syncCallback)

Registers a (sync) callback to be called before each hook is being called.

mimikrook.beforeEach((event) => { console.log(`${event.name} hook is being called with ${event.args}`)}`)
mimikrook.hook('test', () => { console.log('running test hook') })

// test hook is being called with []
// running test hook
await mimikrook.callHook('test')

โญ๏ธ afterEach (syncCallback)

Registers a (sync) callback to be called after each hook is being called.

mimikrook.afterEach((event) => { console.log(`${event.name} hook called with ${event.args}`)}`)
mimikrook.hook('test', () => { console.log('running test hook') })

// running test hook
// test hook called with []
await mimikrook.callHook('test')

๐Ÿ” createDebugger

Automatically logs each hook that is called and how long it takes to run.

const debug = mimikrook.createDebugger(hooks, { tag: 'something' })

hooks.callHook('some-hook', 'some-arg')
// [something] some-hook: 0.21ms

debug.close()

๐Ÿ™ Clone this repository ๐Ÿ”ง Enable Corepack using corepack enable ๐Ÿ“ฆ Install dependencies using nyxi ๐Ÿง™ Always right package manager

๐Ÿ“œ License

MIT - Made with ๐Ÿ’ž

About

๐ŸŽฃ๐Ÿ”— Mimikrook: Awaitable hooks for seamless code enhancement! ๐Ÿ’ช๐Ÿ’ก Boost your development with the power of hooks. ๐Ÿš€

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project