Move the name field on the `page.on('metric') API #1489
Merged
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.
What?
This change does two things:
name
field to the level above.urls
field tomatches
.So from:
to:
Why?
It was unclear what
name
was doing when it was part of the "match
" object and it made it difficult to add other fields to the object to match against.urls
doesn't lend itself to extending with more fields to match against. It also doesn't represent what it is doing, whereasmatches
is a helpful verb that makes it clearer to the user/reader of the API what its impact is.By moving the
name
field one level up, and renamingurls
tomatches
, we can now read this API:as:
Checklist
Related PR(s)/Issue(s)
Updates: #1487