Add reference docs for helper types in TS SDK v3.3.0 #540
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Merged
3 tasks
jpwilliams
added a commit
to inngest/inngest-js
that referenced
this pull request
Oct 17, 2023
…ype (#329) ## Summary <!-- Succinctly describe your change, providing context, what you've changed, and why. --> 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. ```ts 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. ```ts type FunctionInput = GetFunctionInput<typeof inngest>; type FunctionInputWithTrigger = GetFunctionInput<typeof inngest, "app/user.created">; ``` These complement the existing `GetEvents` type available. ```ts type Events = GetEvents<typeof inngest>; ``` Both types include middleware in the result. ## Checklist <!-- Tick these items off as you progress. --> <!-- If an item isn't applicable, ideally please strikeout the item by wrapping it in "~~"" and suffix it with "N/A My reason for skipping this." --> <!-- e.g. "- [ ] ~~Added tests~~ N/A Only touches docs" --> - [x] Added a [docs PR](https://github.com/inngest/website) that references this PR - [x] Added unit/integration tests - [x] Added changesets if applicable ## Related - inngest/website#540
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for inngest/inngest-js#329.