Logo for jsDocs.io

@firebase/functions-types

  • Version 0.6.3
  • Published
  • 6.15 kB
  • No dependencies
  • Apache-2.0 license

Install

npm i @firebase/functions-types
yarn add @firebase/functions-types
pnpm add @firebase/functions-types

Overview

@firebase/functions Types

Index

Classes

Interfaces

Type Aliases

Classes

class FirebaseFunctions

class FirebaseFunctions {}

  • FirebaseFunctions represents a Functions app, and is the entry point for all Functions operations.

method httpsCallable

httpsCallable: (name: string, options?: HttpsCallableOptions) => HttpsCallable;

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

    Parameter name

    The name of the https callable function. The HttpsCallable instance.

method 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.

    Parameter host

    The emulator host (ex: localhost)

    Parameter port

    The emulator port (ex: 5001)

method useFunctionsEmulator

useFunctionsEmulator: (origin: string) => void;

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

    Parameter origin

    The origin of the local emulator, such as "http://localhost:5005".

    Deprecated

    Prefer the useEmulator(host, port) method.

Interfaces

interface HttpsCallable

interface HttpsCallable {}

  • An HttpsCallable is a reference to a "callable" http trigger in Google Cloud Functions.

call signature

(data?: {} | null): Promise<HttpsCallableResult>;

    interface HttpsCallableOptions

    interface HttpsCallableOptions {}

    • HttpsCallableOptions specify metadata about how calls should be executed.

    property timeout

    timeout?: number;

      interface HttpsCallableResult

      interface HttpsCallableResult {}

      • An HttpsCallableResult wraps a single result from a function call.

      property data

      readonly data: any;

        interface HttpsError

        interface HttpsError extends Error {}

          property code

          readonly code: FunctionsErrorCode;

          • A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.

          property details

          readonly details?: any;

          • Extra data to be converted to JSON and included in the error response.

          Type Aliases

          type FunctionsErrorCode

          type FunctionsErrorCode =
              | 'ok'
              | 'cancelled'
              | 'unknown'
              | 'invalid-argument'
              | 'deadline-exceeded'
              | 'not-found'
              | 'already-exists'
              | 'permission-denied'
              | 'resource-exhausted'
              | 'failed-precondition'
              | 'aborted'
              | 'out-of-range'
              | 'unimplemented'
              | 'internal'
              | 'unavailable'
              | 'data-loss'
              | 'unauthenticated';

          • The set of Firebase Functions status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

            Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

          Package Files (1)

          Dependencies (0)

          No dependencies.

          Dev Dependencies (1)

          Peer Dependencies (0)

          No peer dependencies.

          Badge

          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@firebase/functions-types.

          • Markdown
            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@firebase/functions-types)
          • HTML
            <a href="https://www.jsdocs.io/package/@firebase/functions-types"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>