extra-request 8.2.0 → 8.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -25,7 +25,9 @@ const res = await fetch(req)
25
25
  interface IRequestOptions {
26
26
  url?: URL
27
27
  headers?: Headers
28
- payload?: string | FormData
28
+ payload?:
29
+ | BodyInit // WHATWG
30
+ | NodeJS.ReadableStream // node-fetch
29
31
  signal?: AbortSignal
30
32
  keepalive?: boolean
31
33
  redirect?: RequestRedirect
@@ -77,69 +79,69 @@ function pipeRequestOptionsTransformers(
77
79
  function url(url: string, ...baseUrls: string[]): IRequestOptionsTransformer
78
80
  ```
79
81
 
80
- ### text
82
+ #### text
81
83
  ```ts
82
84
  function text(payload: string): IRequestOptionsTransformer
83
85
  ```
84
86
 
85
- ### json
87
+ #### json
86
88
  ```ts
87
89
  function json<T extends JSONValue | JSONSerializable<any>>(
88
90
  payload: T
89
91
  ): IRequestOptionsTransformer
90
92
  ```
91
93
 
92
- ### csv
94
+ #### csv
93
95
  ```ts
94
96
  function csv<T extends object>(payload: T[]): IRequestOptionsTransformer
95
97
  ```
96
98
 
97
- ### signal
99
+ #### signal
98
100
  ```ts
99
101
  function signal(signal: AbortSignal): IRequestOptionsTransformer
100
102
  ```
101
103
 
102
- ### header
104
+ #### header
103
105
  ```ts
104
106
  function header(name: string, value: string): IRequestOptionsTransformer
105
107
  ```
106
108
 
107
- ### appendHeader
109
+ #### appendHeader
108
110
  ```ts
109
111
  function appendHeader(name: string, value: string): IRequestOptionsTransformer
110
112
  ```
111
113
 
112
- ### headers
114
+ #### headers
113
115
  ```ts
114
116
  function headers(headers: { [name: string]: string }): IRequestOptionsTransformer
115
117
  ```
116
118
 
117
- ### host
119
+ #### host
118
120
  ```ts
119
121
  function host(host: string): IRequestOptionsTransformer
120
122
  ```
121
123
 
122
- ### port
124
+ #### port
123
125
  ```ts
124
126
  function port(port: number): IRequestOptionsTransformer
125
127
  ```
126
128
 
127
- ### pathname
129
+ #### pathname
128
130
  ```ts
129
131
  function pathname(pathname: string): IRequestOptionsTransformer
130
132
  ```
131
133
 
132
- ### appendPathname
134
+ #### appendPathname
133
135
  ```ts
134
136
  function appendPathname(pathname: string): IRequestOptionsTransformer
135
137
  ```
136
138
 
137
- ### search
139
+ #### search
138
140
  ```ts
139
141
  function search(search: string): IRequestOptionsTransformer
140
142
  ```
141
143
 
142
- ### searchParam
144
+ #### searchParam
143
145
  ```ts
144
146
  function searchParam(
145
147
  name: string
@@ -147,7 +149,7 @@ function searchParam(
147
149
  ): IRequestOptionsTransformer
148
150
  ```
149
151
 
150
- ### appendSearchParam
152
+ #### appendSearchParam
151
153
  ```ts
152
154
  function appendSearchParam(
153
155
  name: string
@@ -155,14 +157,14 @@ function appendSearchParam(
155
157
  ): IRequestOptionsTransformer
156
158
  ```
157
159
 
158
- ### searchParams
160
+ #### searchParams
159
161
  ```ts
160
162
  function searchParams(
161
163
  searchParams: Record<string, string | number>
162
164
  ): IRequestOptionsTransformer
163
165
  ```
164
166
 
165
- ### formDataField
167
+ #### formDataField
166
168
  ```ts
167
169
  function formDataField(
168
170
  name: string
@@ -170,22 +172,27 @@ function formDataField(
170
172
  ): IRequestOptionsTransformer
171
173
  ```
172
174
 
173
- ### basicAuth
175
+ #### basicAuth
174
176
  ```ts
175
177
  function basicAuth(username: string, password: string): IRequestOptionsTransformer
176
178
  ```
177
179
 
178
- ### bearerAuth
180
+ #### bearerAuth
179
181
  ```ts
180
182
  function bearerAuth(token: string): IRequestOptionsTransformer
181
183
  ```
182
184
 
183
- ### keepalive
185
+ #### keepalive
184
186
  ```ts
185
187
  function keepalive(val: boolean = true): IRequestOptionsTransformer
186
188
  ```
187
189
 
188
- ### redirect
190
+ #### redirect
189
191
  ```ts
190
192
  function redirect(val: RequestRedirect): IRequestOptionsTransformer
191
193
  ```
194
+
195
+ #### body
196
+ ```ts
197
+ function body(val: BodyInit | NodeJS.ReadableStream): IRequestOptionsTransformer
198
+ ```
@@ -1 +1 @@
1
- {"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,EAAE,8BAA8B,EAAE,+CAAiD;AAG1F,MAAM,UAAU,GAAG,CAAC,GAAG,YAAuD;IAC5E,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,GAAG,YAAuD;IAC7E,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAA;AACzC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,GAAG,YAAuD;IAC7E,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAA;AACzC,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,GAAG,YAAuD;IAC5E,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAG,YAAuD;IAC9E,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,GAAG,YAAuD;IAC5E,OAAO,OAAO,CAAC,QAAQ,EAAE,GAAG,YAAY,CAAC,CAAA;AAC3C,CAAC;AAED,SAAS,OAAO,CACd,MAA4D,EAC5D,GAAG,YAAuD;IAE1D,MAAM,cAAc,GAAG,8BAA8B,CAAC,GAAG,YAAY,CAAC,CAAA;IACtE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;IAEnD,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE;QAC1C,MAAM;QACN,OAAO;QACP,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,IAAI,EAAE,cAAc,CAAC,OAAO;QAC5B,SAAS,EAAE,cAAc,CAAC,SAAS;QACnC,QAAQ,EAAE,cAAc,CAAC,QAAQ;KAClC,CAAC,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,EAAE,8BAA8B,EAAE,+CAAiD;AAG1F,MAAM,UAAU,GAAG,CAAC,GAAG,YAAuD;IAC5E,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,GAAG,YAAuD;IAC7E,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAA;AACzC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,GAAG,YAAuD;IAC7E,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAA;AACzC,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,GAAG,YAAuD;IAC5E,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAG,YAAuD;IAC9E,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,GAAG,YAAuD;IAC5E,OAAO,OAAO,CAAC,QAAQ,EAAE,GAAG,YAAY,CAAC,CAAA;AAC3C,CAAC;AAED,SAAS,OAAO,CACd,MAA4D,EAC5D,GAAG,YAAuD;IAE1D,MAAM,cAAc,GAAG,8BAA8B,CAAC,GAAG,YAAY,CAAC,CAAA;IACtE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;IAEnD,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE;QAC1C,MAAM;QACN,OAAO;QACP,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,IAAI,EAAE,cAAc,CAAC,OAAc;QACnC,SAAS,EAAE,cAAc,CAAC,SAAS;QACnC,QAAQ,EAAE,cAAc,CAAC,QAAQ;KAClC,CAAC,CAAA;AACJ,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"basic-auth.js","sourceRoot":"","sources":["../../src/transformers/basic-auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGpC,MAAM,UAAU,SAAS,CAAC,QAAgB,EAAE,QAAgB;IAC1D,OAAO,MAAM,CAAC,eAAe,EAAE,QAAQ,GAAG,IAAI,CAAC,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAA;AAC5E,CAAC"}
1
+ {"version":3,"file":"basic-auth.js","sourceRoot":"","sources":["../../src/transformers/basic-auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGpC,MAAM,UAAU,SAAS,CACvB,QAAgB,EAChB,QAAgB;IAEhB,OAAO,MAAM,CAAC,eAAe,EAAE,QAAQ,GAAG,IAAI,CAAC,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAA;AAC5E,CAAC"}
@@ -0,0 +1,3 @@
1
+ /// <reference types="node" resolution-mode="require"/>
2
+ import { IRequestOptionsTransformer } from "../types.js";
3
+ export declare function body(val: BodyInit | NodeJS.ReadableStream): IRequestOptionsTransformer;
@@ -0,0 +1,9 @@
1
+ export function body(val) {
2
+ return (options) => {
3
+ return {
4
+ ...options,
5
+ payload: val
6
+ };
7
+ };
8
+ }
9
+ //# sourceMappingURL=body.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"body.js","sourceRoot":"","sources":["../../src/transformers/body.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,IAAI,CAAC,GAAqC;IACxD,OAAO,CAAC,OAAwB,EAAE,EAAE;QAClC,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE,GAAG;SACb,CAAA;IACH,CAAC,CAAA;AACH,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"form-data-field.js","sourceRoot":"","sources":["../../src/transformers/form-data-field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAE7C,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,KAA+B;IAE/B,OAAO,CAAC,OAAwB,EAAE,EAAE;QAClC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,YAAY,QAAQ;YAClD,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC;YAChC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAA;QAElB,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;YAClB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;SAC7C;aAAM;YACL,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;SAC7B;QAED,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE,QAAoB;SAC9B,CAAA;IACH,CAAC,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,QAAkB;IACvC,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC7B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE;QAC9C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;KAC3B;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}
1
+ {"version":3,"file":"form-data-field.js","sourceRoot":"","sources":["../../src/transformers/form-data-field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAE7C,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,KAA+B;IAE/B,OAAO,CAAC,OAAwB,EAAE,EAAE;QAClC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,YAAY,QAAQ;YAClD,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC;YAChC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAA;QAElB,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;YAClB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;SAC7C;aAAM;YACL,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;SAC7B;QAED,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE,QAAQ;SAClB,CAAA;IACH,CAAC,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,QAAkB;IACvC,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC7B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE;QAC9C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;KAC3B;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}
@@ -20,3 +20,4 @@ export * from "./bearer-auth.js";
20
20
  export * from "./signal.js";
21
21
  export * from "./keepalive.js";
22
22
  export * from "./redirect.js";
23
+ export * from "./body.js";
@@ -20,4 +20,5 @@ export * from "./bearer-auth.js";
20
20
  export * from "./signal.js";
21
21
  export * from "./keepalive.js";
22
22
  export * from "./redirect.js";
23
+ export * from "./body.js";
23
24
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transformers/index.ts"],"names":[],"mappings":"AAAA,yBAAoC;AAEpC,0BAAqC;AACrC,0BAAqC;AACrC,yBAAoC;AAEpC,4BAAuC;AACvC,mCAA8C;AAC9C,6BAAwC;AACxC,4BAAuC;AAEvC,0BAAqC;AACrC,0BAAqC;AACrC,8BAAyC;AACzC,qCAAgD;AAChD,4BAAuC;AACvC,kCAA6C;AAC7C,mCAA8C;AAC9C,yCAAoD;AAEpD,qCAAgD;AAEhD,gCAA2C;AAC3C,iCAA4C;AAE5C,4BAAuC;AACvC,+BAA0C;AAC1C,8BAAyC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transformers/index.ts"],"names":[],"mappings":"AAAA,yBAAoC;AAEpC,0BAAqC;AACrC,0BAAqC;AACrC,yBAAoC;AAEpC,4BAAuC;AACvC,mCAA8C;AAC9C,6BAAwC;AACxC,4BAAuC;AAEvC,0BAAqC;AACrC,0BAAqC;AACrC,8BAAyC;AACzC,qCAAgD;AAChD,4BAAuC;AACvC,kCAA6C;AAC7C,mCAA8C;AAC9C,yCAAoD;AAEpD,qCAAgD;AAEhD,gCAA2C;AAC3C,iCAA4C;AAE5C,4BAAuC;AACvC,+BAA0C;AAC1C,8BAAyC;AACzC,0BAAqC"}
package/lib/types.d.ts CHANGED
@@ -1,8 +1,9 @@
1
+ /// <reference types="node" resolution-mode="require"/>
1
2
  export declare type IRequestOptionsTransformer = (options: IRequestOptions) => IRequestOptions;
2
3
  export interface IRequestOptions {
3
4
  url: URL;
4
5
  headers: Headers;
5
- payload?: string | FormData;
6
+ payload?: BodyInit | NodeJS.ReadableStream;
6
7
  signal?: AbortSignal;
7
8
  keepalive?: boolean;
8
9
  redirect?: RequestRedirect;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "extra-request",
3
- "version": "8.2.0",
3
+ "version": "8.4.0",
4
4
  "description": "Utilities for Request",
5
5
  "type": "module",
6
6
  "sideEffects": false,