docs(v4): remove event.user from the v4 TypeScript reference - #1809
Open
dirnalafeinte wants to merge 2 commits into
Open
docs(v4): remove event.user from the v4 TypeScript reference#1809dirnalafeinte wants to merge 2 commits into
dirnalafeinte wants to merge 2 commits into
Conversation
The v4 migration guide states that event.user was removed in v4, but the v4 inngest.send() reference still documents it as a payload property, in three code samples and a dedicated encryption section. Following it produces a TypeScript error, as reported in inngest/inngest-js#1610. Drop the user property, the samples that set it, and the user data encryption section from the v4 page. The v3 reference is unchanged.
|
@dirnalafeinte is attempting to deploy a commit to the Inngest Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Clean, consistent removal — the user field is documented as removed in v4 (see v3-to-v4 migration doc), and no other pages link to the deleted "User data encryption" anchor in this file. No issues found.
Re-review (2026-07-25): New commits correctly propagate the event.user removal to the remaining v4 docs (create, debounce, rate-limit, singleton), replacing event.user.email with event.data.email consistently, including the example payload in rate-limit.mdx. No issues found.
The key expression examples for idempotency, rateLimit, debounce, batchEvents and singleton use event.user.email, and the rateLimit example payload sets a top-level user object and reads event.user.email. Both are invalid in v4 since event.user was removed. Move the address into event.data and read it from there.
This file contains hidden or 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
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.
Summary
The v4 migration guide says
event.userwas removed in v4:Several v4 reference pages still document and use it. Following them produces a TypeScript error, which is what was reported in inngest/inngest-js#1610:
On that issue a maintainer confirmed the removal was intentional and noted the migration guide had missed it. #1738 fixed the migration guide; the reference pages were left behind, so the v4 docs now contradict each other.
Changes
v4/events/send.mdx— the page documenteduseras a first-class payload property:userproperty from theeventPayloadreference tableuserfrom the three code samples that set ituserobject and its replay caveatv4/functions/{create,debounce,rate-limit,singleton}.mdx— the CEL key-expression examples foridempotency,rateLimit,debounce,batchEventsandsingletonall readevent.user.email:'event.data.account_id + "-" + event.user.email'→'event.data.account_id + "-" + event.data.email'rate-limitexample payload, moveemailintodataand readevent.data.emailinstead ofevent.user.emailThe v3 reference pages are deliberately untouched —
useris still valid there.Verification
event.userorexternal_idreferences remain on any v4 page (the migration guide keeps its intentional mentions)send.mdx(Properties3/3,Property8/8,Row1/1,Col2/2,Callout1/1)Calloutis still used onsend.mdx, so its import stays validsend.mdxis purely subtractive (33 lines removed); the other four are one-line substitutions plus the payload moveCloses inngest/inngest-js#1610