docs(events): document and deprecate objectId in favor of objectIdStr (AUD-907)#190
Merged
ggoranov-smar merged 3 commits intoJun 29, 2026
Conversation
objectId in favor of objectIdStr (AUD-907)
ggoranov-smar
approved these changes
Jun 29, 2026
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
Documents the
objectIdStrproperty on theEventinterface and marks the older numericobjectIdproperty as deprecated. TheobjectIdStrproperty itself was added to the SDK in #177; this PR adds the user-facing documentation and the deprecation marker.objectIdStrholds the affected object's identifier as a string and supports both numeric and non-numeric identifiers. The existing numericobjectIdproperty is deprecated (kept for backward compatibility) — it contains-1when the identifier is non-numeric, in which case the real value is only available inobjectIdStr. New code should readobjectIdStr.Changes
ADVANCED.md— add an explanatory paragraph plus a before/after code sample to the Event Reporting section showingevent.objectIdStr(preferred) vs.event.objectId(deprecated).lib/events/types.ts— add a JSDoc@deprecatedtag to theobjectIdproperty in theEventinterface pointing toobjectIdStr.CHANGELOG.md— add aDeprecatedentry under Unreleased.Notes for reviewers
objectIdis not scheduled for removal — matching the API changelog (Jun-08-2026). The@deprecatedtag surfaces as an IDE strikethrough; it has no runtime effect. Please flag if you'd prefer stronger or weaker language.dist/lib/events/types.d.tsis not edited here — it regenerates from source on build/release.api-docs.Related
objectIdStrfield, AUD-903)