We should improve documentation about the Tepper API. There are a lot of functions and options that are not documented and can be missed by the user.

We should are more Markdown files or make a kind of documentation website. Those made with pure Markdown and hosted freely in GitHub.

I came across a problem due to a stricter typing in this library compared to supertest:

The signature for send() method is

send(body: Record<string, unknown> | Array<unknown>)

opposed to supertest

send(data?: string | object)

This leads to Index signature is missing in type error when passing classes as parameters.

For example:

class CreateUserDto {
  // ....
}

createUserTepper = async (body: CreateUserDto) => {
    await tepper(app).post('/users').send(body) // Error: Index signature is missing in type
}

createUserTepperV2 = async (body: CreateUserDto) => {
    await tepper(app).post('/users').send(body as unknown as Record<string, unknown>) // Success, but verbose
}

createUserSupertest = async (body: CreateUserDto) => {
    await supertest(app).post('/users').send(body) // Success
}

I propose to relax the typing of the send() methods. My arguments are mainly two:

• It will speed up tests development while using this library and remove verbosity.
• Record<string, unknown> and object are equivalent types at runtime, but a big part of TypeScript's safety comes from the fact that these aren't the same, and that it'll only let you treat an object as a dictionary if it knows it's explicitly intended as one. This is what throws Index signature is missing in type error, and it's thought to stop you from accidentally reading and writing totally non-existent properties on objects. However, for our use case, is type safe enough to just use object instead of Record<string, unknown>.

I could work on this issue. Please, assign it to me if you agree with me in this type relaxation.

Further reading: microsoft/TypeScript#15300

I'm hitting this error:

      at processTicksAndRejections (:61:76)
✗ Unless Middleware custom parameter test > should execute if function returns false [6.72ms]
120 |             else {
121 |                 expect(result.body).toEqual(config.expectedBody);
122 |             }
123 |         }
124 |         if (config.expectedStatus) {
125 |             expect(result.status).toEqual(config.expectedStatus);
                ^
ReferenceError: Can't find variable: expect
      at runExpectations (/home/v1rtl/Coding/tinyhttp/unless/node_modules/tepper/dist/TepperRunner.js:125:12)
      at /home/v1rtl/Coding/tinyhttp/unless/node_modules/tepper/dist/TepperRunner.js:81:8
      at processTicksAndRejections (:61:76)
✗ Unless Middleware custom parameter test > should not execute if function returns true [6.28ms]

My test case is this:

import { describe, it } from 'bun:test'
import { type IncomingMessage, type ServerResponse, createServer } from 'node:http'
import tepper from 'tepper'

function InitAppAndTestUnless(options: UnlessMiddlewareOptions | CustomUnless) {
  const app = createServer<typeof IncomingMessage, typeof ServerResponse>((req, res) => {
    unless({ handler: exampleMiddleware, type: 'mw' }, options)(req, res, () => {
      return
    })
    res.statusCode = 200
    res.end()
  })

  const fetch = tepper(app)

  return fetch
}

it("should execute if path string doesn't match", async () => {
  const fetch = InitAppAndTestUnless({ path: '/test' })

  await fetch.get('/').expectStatus(200).run()
})

I can create a reproduction snippet if needed

If importing in TS with Node16 / NodeNext set I get this:

Node built-in API querystring is legacy and the recommended one is URLSearchParams.

This is important due to how arrays are handled.

With querystring:

{test: ['a', 'b']} => test=a&test=b

With URLSearchParams

{test: ['a', 'b']} => test=a,b

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): replace dependency eslint-plugin-node with eslint-plugin-n 14.0.0
• chore(deps): update dependency eslint to v9

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository