diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b7e822ea..0eaa5aa0e 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 diff --git a/packages/core/test/client.test.ts b/packages/core/test/client.test.ts index 3280b47a5..39441937d 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', () => { diff --git a/packages/core/types/client.d.ts b/packages/core/types/client.d.ts index 1309250b0..98dabdc2e 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;