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

Add Realm.Configuration #6093

Merged
merged 6 commits into from
Aug 24, 2023
Merged

Add Realm.Configuration #6093

merged 6 commits into from
Aug 24, 2023

Conversation

kneth
Copy link
Contributor

@kneth kneth commented Aug 23, 2023

What, How & Why?

This closes #6081 and use typedoc-plugin-missing-exports to resolve missing exports

☑️ ToDos

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

@kneth kneth requested a review from elle-j August 23, 2023 11:14
@cla-bot cla-bot bot added the cla: yes label Aug 23, 2023
@kneth kneth requested a review from takameyer August 23, 2023 11:14
Copy link
Contributor

@takameyer takameyer left a comment

Choose a reason for hiding this comment

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

Awesome! Thanks for doing this! :shipit:

packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
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.

Great, important to get this in!!

packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
packages/realm/src/Configuration.ts Outdated Show resolved Hide resolved
/**
* The function called when opening a Realm for the first time. The function can populate the Realm
* prior to opening it. When calling the callback, the Realm will be in a write transaction.
* @param realm - The newly created Realm
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* @param realm - The newly created Realm
* @param realm - The newly created Realm.

packages/realm/src/Realm.ts Outdated Show resolved Hide resolved
@kneth kneth merged commit 4715caa into main Aug 24, 2023
23 checks passed
@kneth kneth deleted the kneth/docs/realm-configuration branch August 24, 2023 09:57
@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.

API documentation for Realm.Configuration
3 participants