Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GetStepTools<typeof inngest> type for getting generic tooling type #329

Merged
merged 10 commits into from
Oct 17, 2023

Conversation

jpwilliams
Copy link
Member

@jpwilliams jpwilliams commented Sep 28, 2023

Summary

Adds a GetStepTools helper type to go alongside GetEvents to provide users with a way of accessing some of the internal types provided by Inngest.

type StepTools = GetStepTools<typeof inngest>;
type StepToolsWithTrigger = GetStepTools<typeof inngest, "app/user.created">;

Also provides GetFunctionInput to get all input arguments for an Inngest function.

type FunctionInput = GetFunctionInput<typeof inngest>;
type FunctionInputWithTrigger = GetFunctionInput<typeof inngest, "app/user.created">;

These complement the existing GetEvents type available.

type Events = GetEvents<typeof inngest>;

Both types include middleware in the result.

Checklist

  • Added a docs PR that references this PR
  • Added unit/integration tests
  • Added changesets if applicable

Related

@jpwilliams jpwilliams self-assigned this Sep 28, 2023
@changeset-bot
Copy link

changeset-bot bot commented Sep 28, 2023

🦋 Changeset detected

Latest commit: cef7661

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
inngest Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@jpwilliams jpwilliams added the ✨ new New features, integrations, or exports label Oct 11, 2023
@jpwilliams jpwilliams marked this pull request as ready for review October 11, 2023 16:01
@jpwilliams jpwilliams added the prerelease/inngest Create snapshot releases for a PR for the "inngest" package. label Oct 13, 2023
@inngest-release-bot
Copy link
Collaborator

inngest-release-bot commented Oct 13, 2023

A user has added the prerelease/inngest label, so this PR will be published to npm with the tag pr-329. It will be updated with the latest changes as you push commits to this PR.

You can install this prerelease version with:

npm install inngest@pr-329

The last release was built and published from cef7661.

@jpwilliams jpwilliams merged commit 2837296 into main Oct 17, 2023
23 checks passed
@jpwilliams jpwilliams deleted the add-getsteptools branch October 17, 2023 10:53
jpwilliams pushed a commit that referenced this pull request Oct 19, 2023
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## inngest@3.3.0

### Minor Changes

- [#329](#329)
[`2837296`](2837296)
Thanks [@jpwilliams](https://github.com/jpwilliams)! - Added
`GetStepTools<typeof inngest>` and `GetFunctionInput<typeof inngest>`
helper types to aid in building function factories. See [TypeScript
Helpers - Inngest
Documentation](https://www.inngest.com/docs/typescript#helpers) for more
information.

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ new New features, integrations, or exports prerelease/inngest Create snapshot releases for a PR for the "inngest" package.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants