开始使用

安装

bun add @capgo/capacitor-firebase-functions
bunx cap sync

导入

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

API概述

callByName

通过函数名称调用可调用函数。

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

await FirebaseFunctions.callByName({} as CallByNameOptions<RequestData>);

callByUrl

通过URL调用可调用函数。

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

await FirebaseFunctions.callByUrl({} as CallByUrlOptions<RequestData>);

useEmulator

为 Cloud Functions 模拟器配置应用程序。

在 Android 上，必须允许清文本流量。 在 Capacitor 配置中：

{
  server: {
    cleartext: true
  }
}

清文本流量不适合用于生产环境。

import { FirebaseFunctions } from '@capgo/capacitor-firebase-functions';

await FirebaseFunctions.useEmulator({} as UseEmulatorOptions);

类型参考

CallByNameOptions

export interface CallByNameOptions<RequestData = unknown> extends CallOptions<RequestData> {
  /**
   * The name of the callable function.
   *
   * @example 'myFunction'
   * @since 6.1.0
   */
  name: string;
  /**
   * The region of the callable function.
   *
   * @example 'us-central1'
   * @since 6.1.0
   */
  region?: string;
}

CallByNameResult

export type CallByNameResult<ResponseData = unknown> = CallResult<ResponseData>;

CallByUrlOptions

export interface CallByUrlOptions<RequestData = unknown> extends CallOptions<RequestData> {
  /**
   * The URL of the callable function.
   *
   * @example 'https://us-central1-my-project.cloudfunctions.net/myFunction'
   * @since 6.1.0
   */
  url: string;
}

CallByUrlResult

export type CallByUrlResult<ResponseData = unknown> = CallResult<ResponseData>;

UseEmulatorOptions

export interface UseEmulatorOptions {
  /**
   * The emulator host without any port or scheme.
   *
   * Note when using a Android Emulator device: 10.0.2.2 is the special IP address to connect to the 'localhost' of the host computer.
   *
   * @since 6.1.0
   * @example "127.0.0.1"
   */
  host: string;
  /**
   * The emulator port.
   *
   * @since 6.1.0
   * @default 5001
   * @example 5001
   */
  port?: number;
  /**
   * The region the callable functions are located in or a custom domain hosting the callable functions.
   *
   * @example 'us-central1'
   * @example 'https://mydomain.com'
   */
  regionOrCustomDomain?: string;
}

GetPluginVersionResult

export interface GetPluginVersionResult {
  /**
   * The semantic version of this plugin.
   *
   * @since 8.0.1
   */
  version: string;
}

CallResult

export interface CallResult<ResponseData = unknown> {
  /**
   * The result of the callable function.
   *
   * @since 6.1.0
   */
  data: ResponseData;
}

真实数据来源

本页面由插件生成 src/definitions.ts当上游的公共API发生变化时，请重新同步。