Skip to content

Commit

Permalink
Fix User.callFunction JSDoc to match the v11+ API (#5768)
Browse files Browse the repository at this point in the history
  • Loading branch information
nlarew committed Jun 2, 2023
1 parent 3a00265 commit ca790be
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/realm/src/app-services/User.ts
Original file line number Diff line number Diff line change
Expand Up @@ -258,12 +258,13 @@ export class User<
* Call a remote Atlas App Services Function by its name.
* Note: Consider using `functions[name]()` instead of calling this method.
*
* @param name Name of the function.
* @param args Arguments passed to the function.
* @param name Name of the App Services Function.
* @param args Arguments passed to the Function.
* @returns A promise that resolves to the value returned by the Function.
*
* @example
* // These are all equivalent:
* await user.callFunction("doThing", [a1, a2, a3]);
* await user.callFunction("doThing", a1, a2, a3);
* await user.functions.doThing(a1, a2, a3);
* await user.functions["doThing"](a1, a2, a3);
* @example
Expand Down

0 comments on commit ca790be

Please sign in to comment.