feat(request): adds option to return the raw fetch response #463
Conversation
request() now accepts a new rawResponse boolean option to indicate that it should return the fetch response directly to the client. This is useful for piping the response to a stream. AFFECTS PACKAGES: @esri/arcgis-rest-auth @esri/arcgis-rest-feature-service-admin @esri/arcgis-rest-feature-service @esri/arcgis-rest-geocoder @esri/arcgis-rest-sharing stream-response-to-file ISSUES CLOSED: #462
|
@jgravois FYI - for some fns like the geocoding and I also updated the demo by:
|
Codecov Report
@@ Coverage Diff @@
## master #463 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 94 94
Lines 1202 1209 +7
Branches 216 219 +3
=====================================
+ Hits 1202 1209 +7
Continue to review full report at Codecov.
|
| @@ -662,6 +662,7 @@ export class UserSession implements IAuthenticationManager { | |||
| * }) | |||
| * ``` | |||
| * | |||
| * @param requestOptions - Options for the request. NOTE: `rawResponse` is not supported by this operation. | |||
There was a problem hiding this comment.
i can't help but feel like we're ignoring the fact that this is TypeScript by just adding a NOTE: to the documentation here.
i also can't think of an interface name that isn't insane, but we could create one:
export interface IRawResponseNotAllowedRequestOptions {
// everything that *was* in IRequestOptions
}
export interface IRequestOptions extends IProcessedRequestOptions {
rawResponse?: boolean;
}There was a problem hiding this comment.
I say we merge this as is and kick this down the line, until at least the docs can show inherited properties.
But if you're interested, I pushed my WIP on this to #465
| @@ -160,7 +160,7 @@ export interface ICreateServiceResult { | |||
| * }); | |||
| * ``` | |||
| * Create a new [hosted feature service](https://developers.arcgis.com/rest/users-groups-and-items/create-service.htm). After the service has been created, call [`addToServiceDefinition()`](../addToServiceDefinition/) if you'd like to update it's schema. | |||
| * @param requestOptions - Options for the request | |||
| * @param requestOptions - Options for the request. NOTE: `rawResponse` is not supported by this operation. | |||
| * @returns A Promise that resolves with service details once the service has been created | |||
| */ | |||
| export function createFeatureService( | |||
There was a problem hiding this comment.
The problem here is that ICreateServiceRequestOptions doesn't inherit directly from IRequestOptions, and the intermediary interfaces are used by fns that do support rawResponse.
| @@ -163,7 +163,7 @@ function changeGroupSharing( | |||
| /** | |||
| * Find out whether or not an item is already shared with a group. | |||
| * | |||
| * @param requestOptions - Options for the request. | |||
| * @param requestOptions - Options for the request. NOTE: `rawResponse` is not supported by this operation. | |||
There was a problem hiding this comment.
same here.
So in both these cases, we'd have to either duplicate all the otherwise inherited props, or disallow rawResponse in the entire tree of inherited interfaes.
There was a problem hiding this comment.
which is probably fine, I just don't want to work that hard.
There was a problem hiding this comment.
The problem here is that
ICreateServiceRequestOptionsdoesn't inherit directly fromIRequestOptions, and the intermediary interfaces are used by fns that do supportrawResponse.
we'd have to either duplicate all the otherwise inherited props, or disallow
rawResponsein the entire tree of inherited interfaces.
💡
i don't blame you.
You can now pass the
rawResponse:trueoption to indicate that a function should return the fetch response directly to the client. This is useful for piping the response to a stream.AFFECTS PACKAGES:
@esri/arcgis-rest-auth
@esri/arcgis-rest-feature-service-admin
@esri/arcgis-rest-feature-service
@esri/arcgis-rest-geocoder
@esri/arcgis-rest-request
@esri/arcgis-rest-sharing
stream-response-to-file
ISSUES CLOSED: #462