Enrich the docs when it comes to types

[ahmed-hritani]

I noticed that after the addition of #267, there is nothing in the docs to show that esmock is now type generic.

[ahmed-hritani]

Great work on this repo @iambumblehead, it made our lives way easier 🙏

[uwinkelvos]

👍

[iambumblehead]

test('allows you to specify the type of returned exports', async () => {
  const { multiplyNumbers } = await esmock<typeof import('../src/utils.js')>(
    '../src/utils.js', {
    multiplyNumbers: (numbers: number[]): number => numbers.reduce((acc, current) => acc *= current, 1),
  })

  assert.equal(multiplyNumbers([1, 2, 3]), 6)
})

The example only works if strange things happen,

1. there is a package named "multiplyNumbers" exporting only a default function reducer,
2. "../src/utils.js" imports the "multiplyNumbers" package, then exports it to a named-export of the same name; import multiplyNumbers from 'multiplyNumbers'; export { multipyNumbers } (strange)

test('allows you to specify the type of returned exports', async () => {
  const { multiplyNumbers } = await esmock('../src/utils.js', {
    multiplyNumbers: numbers => numbers.reduce((acc, current) => acc *= current, 1)
  })

  assert.equal(multiplyNumbers([1, 2, 3]), 6)
})

The example would be easier to follow if utils used multiply in a more meaningful way and if it imported multiply from an obvious moduleId or path such as "../src/numbers.js", eg something like this,

test('allows you to specify the type of returned exports', async () => {
  const { makebabies } = await esmock('../src/rabbits.js', {
    '../src/numbers.js': {
      multiply: numbers => numbers.reduce((acc, current) => acc *= current, 1)
    }
  })

  assert.equal(makebabies({ pairs: 3 }).length, 28)
})

[iambumblehead]

@ahmed-hritani would you remake the README example to follow these points?

• The example should work. It should be possible to write a real unit-test that passes with the example,
• Each line less than 70 characters wide. This is a special optimization for the README so the examples fit inside most laptop screens without scrollbars,
• The example should be slightly interesting, if possible, and should use a unicode emoji

[iambumblehead]

I like this example and I like if this is added to a separated block from the javascript one,

---

esmock examples in typescript

import test from 'node:test'
import assert from 'node:assert'
import esmock from 'esmock'
import type Rabbit from '../rabbit.js';

test('specify the type of export returned', async () => {
  const rabbit = await esmock<Rabbit>('../rabbit.js', {
    '../util.js': {
      multiply: (numbers: number[]): number => (
        numbers.reduce((acc, n) => acc *= n, 1))
    }
  })
  
  assert.equal(rabbit.makebabies({ pairs: 3 }), '🐇'
    + '🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇'
    + '🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇'
    + '🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇🐇')
})

[ahmed-hritani]

Thank you for your comments @iambumblehead, I created a new PR with an example that (hopefully) follow the constraints and added the constraints to the CONTRIBUTING.md file through a different PR.