Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion for default open behavior #5967

Merged
merged 2 commits into from
Jul 11, 2023

Conversation

takameyer
Copy link
Contributor

* deprecate the static types that were imported from v11
* define the defaults locally in the ProgressRealmPromise
* document what the defaults for these fields are in SyncConfiguration

☑️ ToDos

  • 📝 Changelog entry
  • 📝 Compatibility label is updated or copied from previous entry
  • 📝 Update COMPATIBILITY.md
  • 🚦 Tests
  • 🔀 Executed flexible sync tests locally if modifying flexible sync
  • 📦 Updated internal package version in consuming package.jsons (if updating internal packages)
  • 📱 Check the React Native/other sample apps work if necessary
  • 📝 Public documentation PR created or is not necessary
  • 💥 Breaking label has been applied or is not necessary

If this PR adds or changes public API's:

  • typescript definitions file is updated
  • jsdoc files updated

* deprecate the static types that were imported from v11
* define the defaults locally in the ProgressRealmPromise
* document what the defaults for these fields are in SyncConfiguration
Copy link
Contributor

@elle-j elle-j left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments with questions and ideas 👍

packages/realm/src/ProgressRealmPromise.ts Outdated Show resolved Hide resolved
Comment on lines 178 to 180
static openLocalRealmBehavior = {
type: OpenRealmBehaviorType.OpenImmediately,
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing Readonly<OpenRealmBehaviorConfiguration> might have been accidental? (Same for static downloadBeforeOpenBehavior)

Also, see earlier comment regarding having this reference what is being used internally as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was accidental.

packages/realm/src/app-services/SyncConfiguration.ts Outdated Show resolved Hide resolved
packages/realm/src/app-services/SyncConfiguration.ts Outdated Show resolved Hide resolved
@takameyer takameyer requested a review from papafe July 10, 2023 13:20
Copy link
Contributor

@papafe papafe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@takameyer takameyer merged commit b65c0f5 into fp/default-values Jul 11, 2023
28 of 31 checks passed
@takameyer takameyer deleted the andrew/default-values branch July 11, 2023 08:11
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants