Patch for global config option types (#182)

timetraveler328 · web-flow · commit 8df798856551 · 2023-10-05T16:38:20.000-04:00
* Fixes #181, adds optional global config attributes to options type for pagination and trace. * Changelog * 7.3.2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## [7.3.2](https://github.com/polygon-io/client-js/compare/v7.3.1...v7.3.2) (2023-10-05)
+### Bug Fixes
+* Rearrange request config types so they inherit global options for pagination and trace
+
 ## [7.3.1](https://github.com/polygon-io/client-js/compare/v7.3.0...v7.3.1) (2023-09-15)
 ### Bug Fixes
 * Fix unintended change to top level response object that returned results array instead of results object
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@polygon.io/client-js",
-  "version": "7.3.1",
+  "version": "7.3.2",
   "description": "Isomorphic Javascript client for Polygon.io Stocks, Forex, and Crypto APIs",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
diff --git a/src/rest/transport/request.ts b/src/rest/transport/request.ts
@@ -17,18 +17,20 @@ export interface IRequestInit extends Omit<RequestInit, 'headers'> {
   headers?: IHeaders
 }
 
-export type IRequestOptions = IRequestInit;
+export interface IGlobalOptions extends IRequestInit {
+  trace?: boolean;
+  pagination?: boolean;
+}
+
+export type IRequestOptions = IGlobalOptions;
 
 export interface IPolygonQueryWithCredentials extends IPolygonQuery {
   apiKey: string | boolean;
 }
 
 export type IGet = (path: string, query: IPolygonQuery, options: IRequestOptions) => Promise<any>;
 
-export interface IGlobalOptions extends IRequestOptions {
-  trace?: boolean;
-  pagination?: boolean;
-}
+
 
 export type ICurriedGet = (apiKey: string, apiBase: string, globalOptions?: IGlobalOptions) => IGet;
 export type IStructuredError = InstanceType<typeof StructuredError>;

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@polygon.io/client-js",`
`3`		`- "version": "7.3.1",`
	`3`	`+ "version": "7.3.2",`
`4`	`4`	`"description": "Isomorphic Javascript client for Polygon.io Stocks, Forex, and Crypto APIs",`
`5`	`5`	`"main": "dist/main.js",`
`6`	`6`	`"types": "dist/main.d.ts",`