From 1cec2d736c90bf65d55f8ab9d0835df789ac65ac Mon Sep 17 00:00:00 2001 From: Justin Dalrymple Date: Sat, 16 May 2020 13:33:03 +0200 Subject: [PATCH] Update typing to specify that path or name must be passed (#796) --- packages/gitbeaker-core/src/services/Projects.ts | 5 ++++- .../gitbeaker-core/test/unit/services/Projects.ts | 12 ++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/packages/gitbeaker-core/src/services/Projects.ts b/packages/gitbeaker-core/src/services/Projects.ts index 149223dd..654678a4 100644 --- a/packages/gitbeaker-core/src/services/Projects.ts +++ b/packages/gitbeaker-core/src/services/Projects.ts @@ -61,7 +61,10 @@ export class Projects extends BaseService { return RequestHelper.post(this, `projects/${pId}/archive`, options); } - create({ userId, ...options }: { userId?: number } & BaseRequestOptions) { + create({ + userId, + ...options + }: ({ name: string } | { path: string }) & { userId?: number } & BaseRequestOptions) { const url = userId ? `projects/user/${encodeURIComponent(userId)}` : 'projects'; return RequestHelper.post(this, url, options); diff --git a/packages/gitbeaker-core/test/unit/services/Projects.ts b/packages/gitbeaker-core/test/unit/services/Projects.ts index 37051bc8..97e734a9 100644 --- a/packages/gitbeaker-core/test/unit/services/Projects.ts +++ b/packages/gitbeaker-core/test/unit/services/Projects.ts @@ -56,28 +56,28 @@ describe('Projects.archive', () => { describe('Projects.create', () => { it('should request POST /projects when userId undefined', async () => { - await service.create({ title: 'test proj' }); + await service.create({ name: 'test proj' }); expect(RequestHelper.post).toHaveBeenCalledWith(service, 'projects', { - title: 'test proj', + name: 'test proj', }); }); it('should request POST /projects/user/:id when userId defined', async () => { - await service.create({ userId: 2, title: 'test proj' }); + await service.create({ userId: 2, name: 'test proj' }); expect(RequestHelper.post).toHaveBeenCalledWith(service, 'projects/user/2', { - title: 'test proj', + name: 'test proj', }); }); }); describe('Projects.edit', () => { it('should request PUT /projects', async () => { - await service.edit(12, { title: 'test proj 2' }); + await service.edit(12, { name: 'test proj 2' }); expect(RequestHelper.put).toHaveBeenCalledWith(service, 'projects/12', { - title: 'test proj 2', + name: 'test proj 2', }); }); });