fix: add typings for named parameter structs (#1198)

alvarowolfx · web-flow · commit c7c2ba1bd365 · 2023-03-22T14:47:12.000-04:00
diff --git a/src/bigquery.ts b/src/bigquery.ts
@@ -98,14 +98,27 @@ export type Query = JobRequest<bigquery.IJobConfigurationQuery> & {
   params?: any[] | {[param: string]: any};
   dryRun?: boolean;
   labels?: {[label: string]: string};
-  types?: string[] | string[][] | {[type: string]: string | string[]};
+  types?: QueryParamTypes;
   job?: Job;
   maxResults?: number;
   jobTimeoutMs?: number;
   pageToken?: string;
   wrapIntegers?: boolean | IntegerTypeCastOptions;
 };
 
+export type QueryParamTypeStruct = {
+  [type: string]:
+    | string
+    | string[]
+    | QueryParamTypeStruct
+    | QueryParamTypeStruct[];
+};
+export type QueryParamTypes =
+  | string[]
+  | string[][]
+  | QueryParamTypeStruct
+  | QueryParamTypeStruct[];
+
 export type QueryOptions = QueryResultsOptions;
 export type QueryStreamOptions = {
   wrapIntegers?: boolean | IntegerTypeCastOptions;
diff --git a/system-test/bigquery.ts b/system-test/bigquery.ts
@@ -1220,6 +1220,17 @@ describe('BigQuery', () => {
                     },
                   },
                 ],
+                types: [
+                  {
+                    b: 'BOOL',
+                    arr: ['INT64'],
+                    d: 'DATE',
+                    f: 'FLOAT64',
+                    nested: {
+                      a: 'INT64',
+                    },
+                  },
+                ],
               },
               (err, rows) => {
                 assert.ifError(err);
@@ -1332,6 +1343,9 @@ describe('BigQuery', () => {
                 params: {
                   owner: 'google',
                 },
+                types: {
+                  owner: 'STRING',
+                },
               },
               (err, rows) => {
                 assert.ifError(err);
@@ -1466,6 +1480,17 @@ describe('BigQuery', () => {
                     },
                   },
                 },
+                types: {
+                  obj: {
+                    b: 'BOOL',
+                    arr: ['INT64'],
+                    d: 'DATE',
+                    f: 'FLOAT64',
+                    nested: {
+                      a: 'INT64',
+                    },
+                  },
+                },
               },
               (err, rows) => {
                 assert.ifError(err);
