"AngularFireFunctions" documentation has two errors
- Langage dominant
- TypeScript
- Étoiles
- 7.8k
- Forks
- 2.2k
- Merge moyen
- 22 h 28 min
- PR mergées (30 j)
- 6
Description
The example code in the [AngularFireFunctions](https://github.com/angular/angularfire/blob/master/docs/functions/functions.md) documentation doesn't compile. Here's the provided code, with comments on the two lines that don't compile:
```ts
import { Component } from '@angular/core';
import { AngularFireFunctions } from '@angular/fire/compat/functions';
@Component({
selector: 'app-root',
template: `{ data$ | async }` // doesn't compile
})
export class AppComponent {
constructor(private fns: AngularFireFunctions) {
const callable = fns.httpsCallable('my-fn-name');
this.data$ = callable({ name: 'some-data' }); // doesn't compile
}
}
```
The `template` line needs double curly brackets:
```ts
template: `{{ data$ | async }}`
```
The next error is:
```bash
Property 'data$' does not exist on type 'AppComponent'.
6 template: `{{ data$ | async }}`,
```
I corrected this by making a variable `data$: any`.
This code now compiles:
```ts
import { Component } from '@angular/core';
import { AngularFireFunctions } from '@angular/fire/compat/functions';
@Component({
selector: 'app-component',
template: `{{ data$ | async }}`,
})
export class AppComponent {
data$: any;
constructor(private fns: AngularFireFunctions) {
const callable = fns.httpsCallable('my-fn-name');
this.data$ = callable({ name: 'some-data' });
}
}
```
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Ouvrez docs/functions/functions.md et examinez l’exemple AngularFireFunctions. Vérifiez l’interpolation du template et la déclaration de AppComponent par rapport aux erreurs TypeScript signalées, puis vérifiez que l’exemple corrigé se compile et correspond à l’utilisation documentée des fonctions appelables.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- angular, typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 45/100