Skip to content

Clarify specification for “context.name” for private vs public elements. #570

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.

Sign up for GitHub

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

Open
theengineear wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify specification for “context.name” for private vs public elements. #570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ The context object also varies depending on the value being decorated. Breaking
- `"setter"`
- `"field"`
- `"accessor"`
- `name`: The name of the value, or in the case of private elements the _description_ of it (e.g. the readable name).
- `name`: The string name of the value, or in the case of `private` elements a unique symbol with a _description_ of the value (e.g. `'field'` or `Symbol('#field')`).
- `access`: An object containing methods to access the value. These methods also get the _final_ value of the element on the instance, not the current value passed to the decorator. This is important for most use cases involving access, such as type validators or serializers. See the section on Access below for more details.
- `static`: Whether or not the value is a `static` class element. Only applies to class elements.
- `private`: Whether or not the value is a private class element. Only applies to class elements.
Expand Down