-
Notifications
You must be signed in to change notification settings - Fork 2.2k
docs(*): Document AngularFireFunctions and AngularFireMessaging #1856
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4027dfd
docs(functions): Document AngularFireFunctions
davideast 5a68f24
Update README.md
davideast ca6f4d4
Create messaging.md
davideast 78feef7
Update functions.md
davideast dfc6e84
Update README.md
davideast 6f00194
Update README.md
davideast 9c8e5f3
Update messaging.md
davideast 62d6a00
Minor changes
jamesdaniels 8627776
Merge branch 'master' into de-af-fns-docs
jamesdaniels File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# AngularFireFunctions | ||
|
||
> The Cloud Functions for Firebase client SDKs let you call functions directly from a Firebase app. To call a function from your app in this way, write and deploy an HTTPS Callable function in Cloud Functions, and then add client logic to call the function from your app. | ||
|
||
### Import the `NgModule` | ||
|
||
Cloud Functions for AngularFire is contained in the `@angular/fire/functions` module namespace. Import the `AngularFireFunctionsModule` in your `NgModule`. This sets up the `AngularFireFunction` service for dependency injection. | ||
|
||
```ts | ||
import { BrowserModule } from '@angular/platform-browser'; | ||
import { NgModule } from '@angular/core'; | ||
import { AppComponent } from './app.component'; | ||
import { AngularFireModule } from '@angular/fire'; | ||
import { AngularFireFunctionsModule } from '@angular/fire/functions'; | ||
import { environment } from '../environments/environment'; | ||
|
||
@NgModule({ | ||
imports: [ | ||
BrowserModule, | ||
AngularFireModule.initializeApp(environment.firebase), | ||
AngularFireFunctionsModule | ||
], | ||
declarations: [ AppComponent ], | ||
bootstrap: [ AppComponent ] | ||
}) | ||
export class AppModule {} | ||
``` | ||
|
||
### Injecting the AngularFireFunctions service | ||
|
||
Once the `AngularFireFunctionsModule` is registered you can inject the `AngularFireFunctions` service. | ||
|
||
```ts | ||
import { Component } from '@angular/core'; | ||
import { AngularFireFunctions } from '@angular/fire/functions'; | ||
|
||
@Component({ | ||
selector: 'app-component', | ||
template: `` | ||
}) | ||
export class AppComponent { | ||
constructor(private fns: AngularFireFunctions { } | ||
} | ||
``` | ||
|
||
### Creating a callable function | ||
|
||
AngularFireFunctions is super easy. You create a function on the server side and then "call" it by its name with the client library. | ||
|
||
| method | | | ||
| ---------|--------------------| | ||
| `httpCallable(name: string): (data: T) ` | Creates a callable function based on a function name. Returns a function that can create the observable of the http call. | | ||
```ts | ||
|
||
import { Component } from '@angular/core'; | ||
import { AngularFireStorage } from '@angular/fire/functions'; | ||
|
||
@Component({ | ||
selector: 'app-root', | ||
template: ` | ||
{ data$ } | async | ||
` | ||
}) | ||
export class AppComponent { | ||
constructor(private fns: AngularFireFunctions) { | ||
const callable = fns.httpsCallable('my-fn-name'); | ||
this.data$ = callable({ name: 'some-data' }); | ||
} | ||
} | ||
``` | ||
|
||
Notice that calling `httpsCallable()` does not initiate the request. It creates a reusable function that is called to initiate the request. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing
)