firebase-functions package

Firebase용 Cloud Functions용 2세대 API 이 SDK는 딥 가져오기를 지원합니다. 예를 들어 pubsub 네임스페이스는 firebase-functions/v2에서 사용하거나 firebase-functions/v2/pubsub에서 직접 가져올 수 있습니다.

함수

함수 설명
setGlobalOptions(options) 2세대 SDK를 사용하여 작성된 모든 함수의 기본 옵션을 설정합니다.

클래스

클래스 설명
변경 실시간 데이터베이스 또는 Cloud Firestore onWriteonUpdate 이벤트와 같이 상태를 변경하는 이벤트를 위한 Cloud Functions 인터페이스입니다.Change 객체를 구성하는 데 사용되는 형식에 대한 자세한 내용은 아래를 참조하세요.

인터페이스

인터페이스 설명
Cloud 이벤트 (베타) CloudEventBase는 서버리스 이벤트를 인코딩하기 위한 크로스 플랫폼 형식의 기반입니다. 자세한 내용은 https://github.com/cloudevents/spec을 참고하세요.
Cloud Functions (베타) CloudEvents의 핸들러입니다.
EventHandlerOptions 모든 이벤트 처리 함수에 설정할 수 있는 추가 필드입니다.
GlobalOptions GlobalOptions는 프로젝트 전체에 설정할 수 있는 옵션입니다. 이러한 옵션은 HTTPS 및 이벤트 처리 함수에 공통적으로 적용됩니다.

네임스페이스

네임스페이스 설명
알림
데이터베이스
eventarc
firestore
https
ID
로거
매개변수
Pub
remoteConfig
스케줄러
스토리지
할 일
testLab

유형 별칭

별칭 입력 설명
인그레스 설정 IngressSettings에 사용할 수 있는 옵션 목록입니다.
MemoryOption Cloud Functions에서 지원하는 사용 가능한 메모리 옵션의 목록입니다.
매개변수 모든 매개변수 캡처 그로퍼를 레코드의 키에 매핑하는 유형입니다. 예: ParamsOf<"users/{uid}"> {uid: string } ParamsOf<"users/{uid}/logs/{log}">임 is { uid: string; log: string } 매개변수<"some/static/data"> {}입니다.유연성을 위해 ParamsOf 는 Record<string, string>입니다.
SupportedRegion Cloud Functions (2세대)에서 지원하는 모든 리전의 목록입니다.
VpcEgressSetting VpcConnectorEgressSettings에 사용할 수 있는 옵션 목록입니다.

setGlobalOptions()

2세대 SDK를 사용하여 작성된 모든 함수의 기본 옵션을 설정합니다.

서명:

export declare function setGlobalOptions(options: GlobalOptions): void;

매개변수

매개변수 유형 설명
옵션 GlobalOptions 기본값으로 설정할 수 있는 옵션

반환:

void

인그레스 설정

IngressSettings에 사용할 수 있는 옵션 목록입니다.

서명:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

메모리 옵션

Cloud Functions에서 지원하는 사용 가능한 메모리 옵션의 목록입니다.

서명:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

매개변수

모든 매개변수 캡처 그로퍼를 레코드의 키에 매핑하는 유형입니다. 예: ParamsOf<"users/{uid}"> {uid: string } ParamsOf<"users/{uid}/logs/{log}">임 is { uid: string; log: string } 매개변수<"some/static/data"> {}

유연성을 위해 ParamsOf는 Record<string, string>입니다.

서명:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

지원되는 지역

Cloud Functions (2세대)에서 지원하는 모든 리전의 목록입니다.

서명:

export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";

VPC 이그레스 설정

VpcConnectorEgressSettings에 사용할 수 있는 옵션 목록입니다.

서명:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";