docs(entity): expose guid as a public getter#8797
Merged
Merged
Conversation
Adds `Entity#guid` as a read-only getter that delegates to the existing `getGuid()` method. Re-marks `getGuid()` as @ignore so it stays callable for existing external tools (e.g. the editor) but no longer surfaces in the generated API reference. Follow-up to #8795, addressing review feedback to prefer a property over a getter method. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
2 participants
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
Entity#guidto a public read/write property — the lazy GUID generation and_entityIndexbookkeeping now live in the getter/setter directly.Entity#getGuid()andEntity#setGuid()are retained as@ignore+@deprecatedwrappers that emitDebug.deprecated(...)and delegate to the property, so existing external callers (notably the editor) keep working.Why
Follow-up to #8795 and #7394. Per review on the previous follow-up:
getGuid/setGuiddeprecated wrappers that call the new property accessors.setGuidworking (via@ignore+ deprecation) doesn't add public API surface and avoids breaking the editor, which calls it in many places.Test plan
npm test— 1720 passing).Entity#guidappears in the generated API reference andgetGuid/setGuiddo not.getGuid()/setGuid()from user code logs a single deprecation warning and still works.🤖 Generated with Claude Code