TypeScript error

[onosendi]

With

const closeListeners = closeWithGrace(
  { delay: 500 },
  async ({ err }) => {
    if (err) {
      fastify.log.error(err);
    }
    await fastify.close();
  },
);

I get

1. Argument of type '({ err }: { err: any; }) => Promise<void>' is not assignable to parameter of type 'CloseWithGraceAsyncCallback | CloseWithGraceCallback | undefined'.
     Type '({ err }: { err: any; }) => Promise<void>' is not assignable to type 'CloseWithGraceAsyncCallback'.
       Types of parameters '__0' and 'options' are incompatible.
         Type '{ err?: Error | undefined; signal?: Signals | undefined; manual?: boolean | undefined; }' is not assignable to type '{ err: any; }'.
           Property 'err' is optional in type '{ err?: Error | undefined; signal?: Signals | undefined; manual?: boolean | undefined; }' but required in type '{ err: any; }'.
2. Binding element 'err' implicitly has an 'any' type.

This, fixes it

const closeListeners = closeWithGrace(
  { delay: 500 },
  async ({ err }: { err?: Error }) => {
    if (err) {
      fastify.log.error(err);
    }
    await fastify.close();
  },
);

[mcollina]

Would you like to send a Pull Request to address this issue? Remember to add unit tests.

[gkampitakis]

I am not convinced this is an issue with the library. The fix should be in your code where you explicitly set the type. Might be wrong of course 🤔

Another example that works as well.

import closeWithGrace, { CloseWithGraceAsyncCallback } from './index';

const callback: CloseWithGraceAsyncCallback =
  async ({ err }) => {
    if (err) {

    }
  };

const closeListeners = closeWithGrace(
  { delay: 500 },
  callback
);

[onosendi]

Would you like to send a Pull Request to address this issue? Remember to add unit tests.

When I have time I'll take a look at it.

[segevfiner]

I think adding an as closeWithGrace.CloseWithGraceAsyncCallback after the inline function expression will also work. I think the cause for this is TypeScript being unable to infer the type of the callback function due to the overload so it just infers it as any.

const closeListeners = closeWithGrace(
  { delay: 500 },
  async ({ err }) => {
    if (err) {
      fastify.log.error(err);
    }
    await fastify.close();
  } as closeWithGrace.CloseWithGraceAsyncCallback,
);

[mckelveygreg]

If you are the latest typescript and don't want to cast, here is a good excuse to use the satisfies keyword!

const closeListeners = closeWithGrace({ delay: 500 }, async function ({ err }) {
  if (err) {
    app.log.error(err)
  }
  await app.close()
} satisfies CloseWithGraceAsyncCallback)

[mcollina]

A PR to fix this would be amazing

[StepanMynarik]

Imported as import * as closeWithGrace from "close-with-grace"; in my TS file.

Runtime I get an error: "closeWithGrace is not a function"

[kibertoad]

@StepanMynarik would you be open to send a PR with fix?

[StepanMynarik]

@kibertoad
Sorry, already using Graceful Server as it better suits my use case.