The Cloud Functions for Firebase service interface.

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

Index

Constructors

Private constructor

Methods

httpsCallable

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

  • Gets anHttpsCallable instance that refers to the function with the givenname.

    Parameters

    • name:string

      The name of the https callable function.

    • Optional options:HttpsCallableOptions

      The options for this HttpsCallable instance.

    ReturnsHttpsCallable

    TheHttpsCallable 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)

    Returnsvoid

useFunctionsEmulator

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-27 UTC.