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

Match types for User#callFunction implementation across platforms #4840

Merged
merged 3 commits into from
Sep 14, 2022

Conversation

takameyer
Copy link
Contributor

@takameyer takameyer commented Aug 30, 2022

What, How & Why?

The unifies the call signature of User#callFunction across all documentation
and platforms.

This closes #3733

☑️ ToDos

  • 📝 Changelog entry
  • 📝 Compatibility label is updated or copied from previous entry
  • 🚦 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
  • Chrome debug API is updated if API is available on React Native

@cla-bot cla-bot bot added the cla: yes label Aug 30, 2022
@takameyer takameyer changed the base branch from master to v11 August 30, 2022 11:54
@takameyer takameyer changed the title andrew/bc 3733 Match types for User#callFunction implementation across platforms Aug 30, 2022
@takameyer takameyer requested review from kraenhansen and kneth August 30, 2022 11:57
Copy link
Contributor

@kneth kneth left a comment

Choose a reason for hiding this comment

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

LGTM. But if it is only documentation changes, it is a breaking change?

@takameyer takameyer mentioned this pull request Aug 30, 2022
11 tasks
@takameyer
Copy link
Contributor Author

@kneth If we removed callFunction it would be a breaking change. I guess that would warrant a broader discussion.

types/index.d.ts Outdated Show resolved Hide resolved
@takameyer takameyer force-pushed the andrew/bc-3733 branch 5 times, most recently from 051d985 to 8652c05 Compare August 31, 2022 11:20
@takameyer
Copy link
Contributor Author

@kneth Went over this with @kraenhansen. This is a breaking change, as it changes the callFunction implementation in realm-js:

    user.callFunction("sum", 1, 2, 3); // Valid
    user.callFunction("sum", [1, 2, 3]); // Invalid

@takameyer takameyer force-pushed the andrew/bc-3733 branch 2 times, most recently from bb86d26 to 88a1fea Compare August 31, 2022 13:14
@kraenhansen kraenhansen force-pushed the v11 branch 6 times, most recently from bd551c6 to bb8ce55 Compare September 13, 2022 07:21
lib/user.js Outdated Show resolved Hide resolved
takameyer and others added 3 commits September 13, 2022 14:08
The positional argument functions have been removed and now
only the object arguments are accepted.
The unifies the call signature of User#callFunction across all documentation
and platforms.
`callFunction` now has the signature:
```javascript
  user.callFunction('func', 1, 2, 3);
```
Co-authored-by: Kræn Hansen <[email protected]>
@takameyer takameyer merged commit bdc14b7 into v11 Sep 14, 2022
@takameyer takameyer deleted the andrew/bc-3733 branch September 14, 2022 07:24
kraenhansen added a commit that referenced this pull request Sep 15, 2022
)

* Remove deprecated EmailPasswordAuth functions (#4842)

The positional argument functions have been removed and now
only the object arguments are accepted.

* Match types for `User#callFunction` implementation across platforms

The unifies the call signature of User#callFunction across all documentation
and platforms.
`callFunction` now has the signature:
```javascript
  user.callFunction('func', 1, 2, 3);
```

* Update lib/user.js

Co-authored-by: Kræn Hansen <[email protected]>

Co-authored-by: Kræn Hansen <[email protected]>
takameyer added a commit that referenced this pull request Sep 15, 2022
)

* Remove deprecated EmailPasswordAuth functions (#4842)

The positional argument functions have been removed and now
only the object arguments are accepted.

* Match types for `User#callFunction` implementation across platforms

The unifies the call signature of User#callFunction across all documentation
and platforms.
`callFunction` now has the signature:
```javascript
  user.callFunction('func', 1, 2, 3);
```

* Update lib/user.js

Co-authored-by: Kræn Hansen <[email protected]>

Co-authored-by: Kræn Hansen <[email protected]>
kraenhansen added a commit that referenced this pull request Oct 18, 2022
)

* Remove deprecated EmailPasswordAuth functions (#4842)

The positional argument functions have been removed and now
only the object arguments are accepted.

* Match types for `User#callFunction` implementation across platforms

The unifies the call signature of User#callFunction across all documentation
and platforms.
`callFunction` now has the signature:
```javascript
  user.callFunction('func', 1, 2, 3);
```

* Update lib/user.js

Co-authored-by: Kræn Hansen <[email protected]>

Co-authored-by: Kræn Hansen <[email protected]>
@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