From 2af1b5d2d9fa33884ebd9722e06450a534af85a0 Mon Sep 17 00:00:00 2001 From: Aleksander Grzegorzewski Date: Mon, 25 Nov 2024 15:50:58 +0100 Subject: [PATCH 1/3] corrected setUser interface to allow null --- packages/core/types/client.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/types/client.d.ts b/packages/core/types/client.d.ts index 1309250b03..98dabdc2ec 100644 --- a/packages/core/types/client.d.ts +++ b/packages/core/types/client.d.ts @@ -52,7 +52,7 @@ declare class Client { // user public getUser(): User; - public setUser(id?: string, email?: string, name?: string): void; + public setUser(id?: string | null, email?: string | null, name?: string | null): void; // sessions public startSession(): Client; From 299f664c3c0b7c954117fe51ee8da227fc1bce3c Mon Sep 17 00:00:00 2001 From: Aleksander Grzegorzewski Date: Mon, 25 Nov 2024 16:42:58 +0100 Subject: [PATCH 2/3] added tests --- packages/core/test/client.test.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/core/test/client.test.ts b/packages/core/test/client.test.ts index 3280b47a50..39441937de 100644 --- a/packages/core/test/client.test.ts +++ b/packages/core/test/client.test.ts @@ -871,6 +871,10 @@ describe('@bugsnag/core/client', () => { expect(c.getUser()).toEqual({ id: '123', email: 'bug@sn.ag', name: 'Bug S. Nag' }) c.setUser() expect(c.getUser()).toEqual({ id: undefined, email: undefined, name: undefined }) + c.setUser(null, null, null) + expect(c.getUser()).toEqual({ id: null, email: null, name: null }) + c.setUser('123', null, 'Bug S. Nag') + expect(c.getUser()).toEqual({ id: '123', email: null, name: 'Bug S. Nag' }) }) it('can be set via config', () => { From cb0081af153c2d828b3649c433b2ccffd0a3d080 Mon Sep 17 00:00:00 2001 From: Ben Wilson Date: Tue, 7 Jan 2025 13:13:49 +0000 Subject: [PATCH 3/3] docs: :memo: update CHANGELOG --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b7e822ea7..0eaa5aa0e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ - (plugin-angular) Generate type definition using Angular 17 [#2275](https://github.com/bugsnag/bugsnag-js/pull/2275) +### Fixed + +- Corrected setUser TS interface to allow for null arguments [#2262](https://github.com/bugsnag/bugsnag-js/pull/2262) + ## [8.1.3] - 2024-11-28 ### Changed