refactor: update identify method to optionally return results #1049
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
@launchdarkly/browser size report |
Contributor
|
@launchdarkly/js-sdk-common size report |
Contributor
|
@launchdarkly/js-client-sdk size report |
joker23
force-pushed
the
skz/sdk-1657/client-side-identify
branch
from
216120d to
1a58ddc
Compare
Contributor
|
@launchdarkly/js-client-sdk-common size report |
- Modified the `identify` method in `LDClientImpl` to return a promise with the results of the identification operation when `returnResults` is set to true in `identifyOptions`. - Updated `BrowserClientImpl` to align with the new `identify` method signature, ensuring it now calls the updated method and handles results appropriately. - Added documentation for the new `returnResults` option in `LDIdentifyOptions` to clarify its usage and behavior.
joker23
force-pushed
the
skz/sdk-1657/client-side-identify
branch
from
1a58ddc to
7fcd513
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Requirements
Related issues
sdk-1657
Describe the solution you've provided
identifymethod inLDClientImplto return a promise with the results of the identification operation whenreturnResultsis set to true inidentifyOptions.BrowserClientImplto align with the newidentifymethod signature, ensuring it now calls the updated method and handles results appropriately.returnResultsoption inLDIdentifyOptionsto clarify its usage and behavior.Additional context
I made this change to make it easier for us to transition the identify method signiture for RN. In the browser 4.x SDK we are hardcoding the identify method to the new implementation. The idea here is to allow developers to easily revert to previous behavior if necessary.
Note
Introduces optional result-returning behavior for
identifyand aligns the browser client with it.LDClient.identifyto returnPromise<void | LDIdentifyResult>;LDClientImpl.identifyreturnsidentifyResultwhenidentifyOptions.returnResultsis true, otherwise preserves existing throw-on-error behaviorreturnResultstoLDIdentifyOptionswith documentationidentifyto requirestart()first, defaultsheddable=true, forcesreturnResults=true, starts goal tracking;start()now callsidentifyinstead ofidentifyResult; PIMPL mapping updated toidentifyWritten by Cursor Bugbot for commit 7fcd513. This will update automatically on new commits. Configure here.