Skip to content

Commit ba5cb3a

Browse files
paulstelzerjamesdaniels
authored andcommittedNov 6, 2018
fix(functions): Set default functions region and add documentation - fix #1945 (#1946)
* fix(functions): Set default functions region and add documentation * docs(functions): Fix display issue
1 parent b2d44a8 commit ba5cb3a

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed
 

‎docs/functions/functions.md

+23
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,29 @@ import { environment } from '../environments/environment';
2626
export class AppModule {}
2727
```
2828

29+
### Configure the Function region with the FunctionsRegionToken Injection Token
30+
31+
Allow configuration of Function region with the `FunctionsRegionToken` Injection Token by adding it to the `providers` section of your `NgModule`. The default is `us-central1`.
32+
33+
```ts
34+
import { NgModule } from '@angular/core';
35+
import { AngularFireFunctionsModule, FunctionsRegionToken } from '@angular/fire/functions';
36+
37+
@NgModule({
38+
imports: [
39+
...
40+
AngularFireFunctionsModule,
41+
...
42+
],
43+
...
44+
providers: [
45+
{ provide: FunctionsRegionToken, useValue: 'asia-northeast1' }
46+
]
47+
})
48+
export class AppModule {}
49+
50+
```
51+
2952
### Injecting the AngularFireFunctions service
3053

3154
Once the `AngularFireFunctionsModule` is registered you can inject the `AngularFireFunctions` service.

‎src/functions/functions.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { FirebaseOptions, FirebaseAppConfig } from '@angular/fire';
55
import { FirebaseFunctions, FirebaseOptionsToken, FirebaseNameOrConfigToken, _firebaseAppFactory, FirebaseZoneScheduler } from '@angular/fire';
66

77
export const FunctionsRegionToken = new InjectionToken<string>('angularfire2.functions.region');
8+
export const FunctionsDefaultRegion = 'us-central1';
89

910
@Injectable()
1011
export class AngularFireFunctions {
@@ -27,7 +28,7 @@ export class AngularFireFunctions {
2728

2829
this.functions = zone.runOutsideAngular(() => {
2930
const app = _firebaseAppFactory(options, nameOrConfig);
30-
return app.functions(region);
31+
return app.functions(region || FunctionsDefaultRegion);
3132
});
3233

3334
}

0 commit comments

Comments
 (0)