Skip to content

Add positional parameters to Functions hooks #80

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.

Sign up for GitHub

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

Merged
erayerdin merged 3 commits into from
Feb 18, 2024
Merged

Add positional parameters to Functions hooks #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14362d0
sync functions dependencies
erayerdin Feb 18, 2024
3904465
make functions a positional parameter
erayerdin Feb 18, 2024
3e73922
update docs
erayerdin Feb 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/hooks/useCallFunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
`useCallFunction` hook is used to invoke a function in Firebase Functions. A very simple example would be:

```typescript
const { invoke } = useCallFunction({ functions, name: "yourFunctionName" });
const { invoke } = useCallFunction(functions, { name: "yourFunctionName" });
const result = await invoke({
// ... request data to send ...
});
Expand All @@ -35,8 +35,9 @@ Input parameters for `useCallFunction` hook is as follows:
| Name | Type | Description | Required | Default Value |
|---|---|---|---|---|
| `functions` | [`firebase/functions/Functions`][FunctionsRefDoc] | Reference to the Firebase Functions service instance. | ✅ | - |
| `name` | `string` | The name of the function to be called. | ✅ | - |
| `httpsCallableOptions` | [`firebase/functions/HttpsCallableOptions`][HttpsCallableOptionsRefDoc] | The options for callable. | ❌ | `undefined` |
| `options` | `Object` | Options for the process. | ✅ | See below. |
| `options.name` | `string` | The name of the function to be called. | ✅ | - |
| `options.httpsCallableOptions` | [`firebase/functions/HttpsCallableOptions`][HttpsCallableOptionsRefDoc] | The options for callable. | ❌ | `undefined` |

## Return Type

Expand Down
Loading