Define a type for items in "SearchIssuesAndPullRequestsResponseData" type.

[sarvaje]

The property items in the type SearchIssuesAndPullRequestsResponseData doesn't have it's own exported type. it would be nice to have that type defined and exported so we can use in some helpers methods.

For now I'm copy/pasting the code from 'generated/endpoints.ts` and creating the type in my code.

Maybe there is another workaround, but I couldn't find anything.

[gr2m]

you can access all the types you need using the exported Endpoint type, see https://github.com/octokit/types.ts#get-parameter-and-response-data-types-for-a-rest-api-endpoint

For example, to get the response type for PATCH /repos/:owner/:repo/issues/:issue_number, you can do this

const { Endpoints } = require("@octokit/types");
type SearchIssuesAndPullRequestsResponseDataItem = Endpoints["GET /search/issues"]["response"]["data"]["items"][0]

Does that work for you?

I am considering to export the named types, too, but there are a lot of name changes happening right now as part of a big audit. I'll look into that again in 2-3 months

[sarvaje]

@gr2m thanks for your quick response.

Only one comment about your type, it is missing the ["response"] part.

This type is the one that works for me:

type SearchItem = Endpoints['GET /search/issues']['response']['data']['items'][0];

Thanks for your help, it would be very nice see the types named in a few months :)

[gr2m]

Thank you, I fixed it in my example

[nturinski]

This would be a nice feature, but will use the mentioned workaround in the meantime 😃

[gr2m]

You can now also get it from @octokit/openapi-types, which is directly generated from GitHub's official OpenAPI spec, and it will be soon consumed by @octokit/types (see #161). The response data is defined here:

https://github.com/octokit/openapi-types.ts/blob/main/generated/types.ts#L17873-L17877

But you can import "issue-search-result-item" like this

import { components } from "@octokit/openapi-types"

components["schemas"]["issue-search-result-item"]

Hope that works? I do not plan to add other exports at this point.

[octokitbot]

🎉 This issue has been resolved in version 6.0.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀