This repository has been archived by the owner on Feb 7, 2023. It is now read-only.
Clarify that there are two distinct types of cf object #18
Conversation
This file contains 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
Fixes cloudflare#15. There are two distinct cf objects serves associated with a Request: 1. On an eyeball Request attached to a FetchEvent, the cf property contains metadata about the request, provided by Cloudflare's edge. 2. As part of a dictionary of configuration passed to the Request constructor, the cf property allows a user to control certain Cloudflare functionality that can be applied to said Request, like image resizing. While those two things are both objects in a dictionary with the key "cf", they are otherwise distinct. This change makes these two types explicitly different, and specifies that a Request constructor's RequestInit dict can have a "cf" property that is either (1) or (2). Previously, passing a Request object as the `init` arg to the Request constructor failed, because an eyeball request's cf prop did not have the same shape as (2).
harrishancock
approved these changes
May 12, 2020
jrf0110
approved these changes
May 12, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #15.
There are two distinct cf objects associated with a Request:
contains metadata about the request, provided by Cloudflare's
edge.
constructor, the cf property allows a user to control certain
Cloudflare functionality that can be applied to said Request,
like image resizing.
While those two things are both objects with the key "cf", they are otherwise distinct.
This change makes these two types explicitly different, and specifies that a Request constructor's RequestInit dict can have a "cf" property that is either (1) or (2).
Previously, passing a Request object as the
initarg to the Request constructor failed, because it expected a cf prop with the shape (2), and an eyeball request's cf prop has the shape of (1).This change does not make any changes to the actual members of the
cfdictionary – all the changes are whitespace and reorganization. I recommend reviewing changes ignoring whitespace: https://github.com/cloudflare/workers-types/pull/18/files?diff=unified&w=1