Updating callable functions documentation #3277
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In
app.module.ts
I put in commented out lines anticipating AngularFire 7. When AngularFire 7 is available for callable functions we can easily update the documentation with a few clicks.I also put in two lines showing how to run your functions in the Firebase emulator. I clearly indicated how to comment out these lines to run your functions in the cloud.
I made an HTML view to show how to handle user input. Also I added a second set of curly brackets to
{{ data$ | async }}
. This is necessary to make the code run without throwing errors.In
app.component.ts
I put in lines anticipating AngularFire 7.I moved the template to an HTML view.
I added a variable
data$
to handle the data returned from the cloud function. I addedthis
tofns.httpsCallable('my-fn-name');
. These changes are necessary to make the code run without throwing errors.I changed
fns
tofunctions
for readability.I made two functions, one that executes on page load and the user executes on user input.
I put in the
index.js
file showing the cloud functions. The old documentation was confusing as to what data went from Angular to the cloud function and what data was returned from the cloud function. Showing theindex.js
functions clarifies this.I've written a longer tutorial at https://github.com/tdkehoe/Firebase-Cloud-Functions-with-Angular/blob/main/README.md.
When can we expect to use AngularFire 7 with callable functions?
Checklist
yarn install
,yarn test
run successfully? (no)Description
Updating the documentation for callable functions. The existing documentation has a few problems: