• firebase.
• functions.
• Functions

The Cloud Functions for Firebase service interface.

Do not call this constructor directly. Instead, use firebase.functions().

Index

Constructors

• constructor

Methods

• httpsCallable
• useEmulator
• useFunctionsEmulator

Constructors

Private constructor

• new Functions ( ) : Functions

• Returns Functions

Methods

httpsCallable

• httpsCallable ( name :  string ,  options ? :  HttpsCallableOptions ) : HttpsCallable

• Gets an HttpsCallable instance that refers to the function with the given name.

  Parameters

  • name: string

    The name of the https callable function.

  • Optional options: HttpsCallableOptions

    The options for this HttpsCallable instance.

  Returns HttpsCallable

  The HttpsCallable instance.

useEmulator

• useEmulator ( host :  string ,  port :  number ) : void

• Modify this instance to communicate with the Cloud Functions emulator.

  Note: this must be called before this instance has been used to do any operations.

  Parameters

  • host: string

    The emulator host (ex: localhost)

  • port: number

    The emulator port (ex: 5001)

  Returns void

useFunctionsEmulator

• useFunctionsEmulator ( url :  string ) : void

• deprecated

  Prefer the useEmulator(host, port) method.

  Changes this instance to point to a Cloud Functions emulator running locally. See https://firebase.google.com/docs/functions/local-emulator

  Parameters

  • url: string

  Returns void