Skip to content

Commit f63555c

Browse files
fix(types): use Metadata for api response type (#222)
1 parent ce071d8 commit f63555c

File tree

6 files changed

+28
-21
lines changed

6 files changed

+28
-21
lines changed

packages/google-cloud-resourcemanager/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ system-test/*key.json
1111
.DS_Store
1212
package-lock.json
1313
.vscode
14+
__pycache__

packages/google-cloud-resourcemanager/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@
5151
"@google-cloud/nodejs-repo-tools": "^3.0.0",
5252
"@types/mocha": "^5.2.5",
5353
"@types/proxyquire": "^1.3.28",
54-
"@types/request": "^2.47.1",
5554
"@types/uuid": "^3.4.3",
5655
"arrify": "^2.0.0",
5756
"codecov": "^3.0.0",

packages/google-cloud-resourcemanager/src/index.ts

+10-6
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,30 @@
1414
* limitations under the License.
1515
*/
1616

17-
import {GoogleAuthOptions, Operation, Service} from '@google-cloud/common';
17+
import {
18+
GoogleAuthOptions,
19+
Operation,
20+
Service,
21+
Metadata,
22+
} from '@google-cloud/common';
1823
import {paginator} from '@google-cloud/paginator';
1924
import {promisifyAll} from '@google-cloud/promisify';
20-
import * as r from 'request'; // Only for type declarations.
2125

2226
import {Project} from './project';
2327

2428
export type CreateProjectCallback = (
2529
err: Error | null,
2630
project?: Project | null,
2731
operation?: Operation<Project>,
28-
apiResponse?: r.Response
32+
apiResponse?: Metadata
2933
) => void;
30-
export type CreateProjectResponse = [Project, Operation<Project>, r.Response];
31-
export type GetProjectsResponse = [Project[], r.Response];
34+
export type CreateProjectResponse = [Project, Operation<Project>, Metadata];
35+
export type GetProjectsResponse = [Project[], Metadata];
3236
export type GetProjectsCallback = (
3337
err: Error | null,
3438
projects?: Project[] | null,
3539
nextQuery?: {} | null,
36-
apiResponse?: r.Response
40+
apiResponse?: Metadata
3741
) => void;
3842

3943
export interface GetProjectOptions {

packages/google-cloud-resourcemanager/src/project.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,24 @@
1414
* limitations under the License.
1515
*/
1616

17-
import {Operation, ServiceObject, util} from '@google-cloud/common';
17+
import {Operation, ServiceObject, util, Metadata} from '@google-cloud/common';
1818
import {promisifyAll} from '@google-cloud/promisify';
19-
import * as r from 'request'; // Only for type declarations.
2019

2120
import {CreateProjectCallback, CreateProjectResponse, Resource} from '.';
2221

2322
export type RestoreCallback = (
2423
err: Error | null,
25-
apiResonse?: r.Response
24+
apiResonse?: Metadata
2625
) => void;
27-
export type RestoreResponse = [r.Response];
26+
export type RestoreResponse = [Metadata];
2827

29-
export type ProjectCreateResponse = [Project, Operation<Project>, r.Response];
28+
export type ProjectCreateResponse = [Project, Operation<Project>, Metadata];
3029
export interface ProjectCreateCallback {
3130
(
3231
err: Error | null,
3332
project?: Project,
3433
operation?: Operation<Project>,
35-
apiResponse?: r.Response
34+
apiResponse?: Metadata
3635
): void;
3736
}
3837

packages/google-cloud-resourcemanager/test/index.ts

+10-6
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,16 @@
1414
* limitations under the License.
1515
*/
1616

17-
import {DecorateRequestOptions, Operation, util} from '@google-cloud/common';
17+
import {
18+
DecorateRequestOptions,
19+
Operation,
20+
util,
21+
Metadata,
22+
} from '@google-cloud/common';
1823
import {MakeAuthenticatedRequestFactoryConfig} from '@google-cloud/common/build/src/util';
1924
import arrify = require('arrify');
2025
import * as assert from 'assert';
2126
import * as proxyquire from 'proxyquire';
22-
import {Response} from 'request';
2327

2428
import * as root from '../src';
2529
import {Project} from '../src';
@@ -196,7 +200,7 @@ describe('Resource', () => {
196200
resource.createProject(
197201
NEW_PROJECT_ID,
198202
OPTIONS,
199-
(err: Error, p: Project, res: Response) => {
203+
(err: Error, p: Project, res: Metadata) => {
200204
assert.strictEqual(err, error);
201205
assert.strictEqual(p, null);
202206
assert.strictEqual(res, apiResponse);
@@ -235,7 +239,7 @@ describe('Resource', () => {
235239
resource.createProject(
236240
NEW_PROJECT_ID,
237241
OPTIONS,
238-
(e: Error, p: Project, o: Operation, res: Response) => {
242+
(e: Error, p: Project, o: Operation, res: Metadata) => {
239243
assert.ifError(e);
240244
assert.strictEqual(p, project);
241245
assert.strictEqual(o, fakeOperation);
@@ -287,7 +291,7 @@ describe('Resource', () => {
287291
err: Error,
288292
projects: Project[],
289293
nextQuery: {},
290-
apiResp: Response
294+
apiResp: Metadata
291295
) => {
292296
assert.strictEqual(err, error);
293297
assert.strictEqual(projects, null);
@@ -355,7 +359,7 @@ describe('Resource', () => {
355359
err: Error,
356360
projects: Project[],
357361
nextQuery: {},
358-
apiResp: Response
362+
apiResp: Metadata
359363
) => {
360364
assert.ifError(err);
361365
assert.strictEqual(projects[0], project);

packages/google-cloud-resourcemanager/test/project.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ import {
1919
ServiceObject,
2020
ServiceObjectConfig,
2121
util,
22+
Metadata,
2223
} from '@google-cloud/common';
2324
import * as promisify from '@google-cloud/promisify';
2425
import * as assert from 'assert';
2526
import * as proxyquire from 'proxyquire';
26-
import {Response} from 'request';
2727

2828
let promisified = false;
2929
const fakePromisify = Object.assign({}, promisify, {
@@ -128,7 +128,7 @@ describe('Project', () => {
128128
});
129129

130130
it('should execute the callback with error & API response', done => {
131-
project.restore((err: Error, apiResponse_: Response) => {
131+
project.restore((err: Error, apiResponse_: Metadata) => {
132132
assert.strictEqual(err, error);
133133
assert.strictEqual(apiResponse_, apiResponse);
134134
done();

0 commit comments

Comments
 (0)