Skip to content

Commit 195bd33

Browse files
authored
docs(browser-sdk): Upgrading to 3.0 from 2.x (#350)
1 parent 9d0eabe commit 195bd33

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

packages/browser-sdk/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,13 @@ The two cookies are:
320320
- `bucket-prompt-${userId}`: store the last automated feedback prompt message ID received to avoid repeating surveys
321321
- `bucket-token-${userId}`: caching a token used to connect to Bucket's live messaging infrastructure that is used to deliver automated feedback surveys in real time.
322322

323+
### Upgrading to 3.0 from 2.x
324+
325+
Breaking changes:
326+
327+
- `client.onFeaturesUpdated()` is now replaced by [event listeners](#event-listeners)
328+
- Arguments to the `BucketClient` constructor which were previously under `featureOptions` are now supplied directly in the root.
329+
323330
### TypeScript
324331

325332
Types are bundled together with the library and exposed automatically when importing through a package manager.

packages/browser-sdk/src/client.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -805,8 +805,6 @@ export class BucketClient {
805805
/**
806806
* Stop the SDK.
807807
* This will stop any automated feedback surveys.
808-
* It will also stop the features client, including removing
809-
* any onFeaturesUpdated listeners.
810808
*
811809
**/
812810
async stop() {

0 commit comments

Comments
 (0)