Firebase용 Cloud Functions용 2세대 API입니다. 이 SDK는 깊은 가져오기를 지원합니다. 예를 들어 pubsub 네임스페이스는 firebase-functions/v2 에서 사용 가능하거나 firebase-functions/v2/pubsub 에서 직접 가져올 수 있습니다. .
기능
| 기능 | 설명 |
|---|---|
| setGlobalOptions(옵션) | 2세대 SDK를 사용하여 작성된 모든 함수에 대한 기본 옵션을 설정합니다. |
클래스
| 수업 | 설명 |
|---|---|
| 변화 | 실시간 데이터베이스 또는 Cloud Firestore onWrite 및 onUpdate 이벤트와 같이 상태를 변경하는 이벤트를 위한 Cloud Functions 인터페이스입니다. Change 객체를 구성하는 데 사용되는 형식에 대한 자세한 내용은 아래를 참조하세요. |
인터페이스
| 상호 작용 | 설명 |
|---|---|
| 클라우드이벤트 | (베타) CloudEventBase 는 서버리스 이벤트를 인코딩하기 위한 크로스 플랫폼 형식의 기반입니다. 자세한 내용은 https://github.com/cloudevents/spec을 참조하세요. |
| CloudFunction | (베타) CloudEvents용 핸들러입니다. |
| 이벤트 핸들러 옵션 | 모든 이벤트 처리 기능에 설정할 수 있는 추가 필드입니다. |
| 글로벌옵션 | GlobalOptions 전체 프로젝트에 걸쳐 설정할 수 있는 옵션입니다. 이러한 옵션은 HTTPS 및 이벤트 처리 기능에 공통됩니다. |
네임스페이스
| 네임스페이스 | 설명 |
|---|---|
| 경고 | |
| 데이터 베이스 | |
| 이벤트 아크 | |
| 소방서 | |
| https | |
| 신원 | |
| 나무꾼 | |
| 매개변수 | |
| 게시자 | |
| 원격 구성 | |
| 스케줄러 | |
| 저장 | |
| 작업 | |
| 테스트랩 |
유형 별칭
| 유형 별칭 | 설명 |
|---|---|
| 수신 설정 | IngressSettings 에 사용 가능한 옵션 목록입니다. |
| 메모리옵션 | Cloud Functions에서 지원하는 사용 가능한 메모리 옵션 목록입니다. |
| ParamsOf | 모든 매개변수 캡처 그룹을 레코드의 키에 매핑하는 유형입니다. 예를 들어 ParamsOf < "사용자/ { UID } " >는 { uid: string } ParamsOf입니다. < "사용자/ { UID } /로그/ { 통나무 } " >는 { uid: 문자열; 로그: 문자열 } ParamsOf < "일부/정적/데이터" >는 { } 유연성을 이유로 ParamsOf는 |
| 지원지역 | Cloud Functions(2세대)에서 지원되는 모든 지역 목록입니다. |
| Vpc송신 설정 | VpcConnectorEgressSettings 에 사용 가능한 옵션 목록입니다. |
setGlobalOptions()
2세대 SDK를 사용하여 작성된 모든 함수에 대한 기본 옵션을 설정합니다.
서명:
export declare function setGlobalOptions(options: 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
모든 매개변수 캡처 그룹을 레코드의 키에 매핑하는 유형입니다. 예를 들어 ParamsOf < "사용자/ { UID } " >는 { uid: string } ParamsOf입니다. < "사용자/ { UID } /로그/ { 통나무 } " >는 { uid: 문자열; 로그: 문자열 } ParamsOf < "일부/정적/데이터" >는 { }
유연성을 이유로 ParamsOf는
서명:
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";