[FEAT]: request to export event handler parameter type about webhooks.js HOT 7 CLOSED

Sorry, I didn't realize you were using @octokit/app.

The solution you posted is almost entirely correct.

You don't have to pass the event to HandlerFunction<E, TTransformed>
The first parameter is the event name, the second is the value that is added onto the event object in the internals of the type.
The T & { octokit: Octokit } is extraneous

You can simply do it this way:

type _HandlerFunction<T extends EmitterWebhookEventName> = HandlerFunction<
  T,
  { octokit: Octokit }
>

from webhooks.js.

Your example has a syntax error.

I'm not sure why you would want to do that.

All the types for HandlerFunction are exported

You can simply do:

const onDeploymentStatus: HandlerFunction<"deployment_status"> = (event) => {
  // ...
}
app.on('deployment_status', onDeploymentStatus)

from webhooks.js.

HandlerFunction doesn't appear to be exported in "@octokit/webhooks": "^12.0.3". Am I missing something?

from webhooks.js.

It isn't directly exported.

You have to import it from a specific file,

import type { HandlerFunction } from "@octokit/webhooks/dist-types/types.d";

from webhooks.js.

That works but octokit isn't provided by HandlerFunction

import type { HandlerFunction } from "@octokit/webhooks/dist-types/types.d"

const onPullRequestClosed: HandlerFunction<
  "pull_request.opened",
  unknown
> = async ({ octokit, payload }) => { ... }

from webhooks.js.

Can you share what versions of Probot/Octokit packages you are using

from webhooks.js.

I'm using @octokit/[email protected], but HandlerFunction is coming from @octokit/[email protected]. Maybe I need the version from the @octokit/app package.

import type { HandlerFunction } from "@octokit/webhooks/dist-types/types.d"

const onPullRequestOpened: HandlerFunction<
  "pull_request.opened",
  unknown
> = async ({ octokit, payload }) => {}

Update:

Here's what I did to get it working with Octokit

import { Octokit } from "@octokit/rest"
import type { EmitterWebhookEventName } from "@octokit/webhooks"
import type { HandlerFunction } from "@octokit/webhooks/dist-types/types.d"

type _HandlerFunction<T extends EmitterWebhookEventName> = HandlerFunction<
  T,
  T & { octokit: Octokit }
>
const onPullRequestOpened: _HandlerFunction<"pull_request.opened"> = async ({
  octokit,
  payload,
}) => { ... }

from webhooks.js.