기능
| 기능 | 설명 |
|---|---|
| 구성() | 타사 API 키 또는 기타 설정과 같은 프로젝트 구성 데이터를 저장하고 검색합니다. [환경 구성](/docs/functions/config-env)에 설명된 대로 Firebase CLI를 사용하여 구성 값을 설정할 수 있습니다. |
| optionsToEndpoint(옵션) | |
| optionsToTrigger(옵션) | |
| 지역(지역) | 함수가 배포되는 지역을 구성합니다. |
| runWith(런타임옵션) | 함수에 대한 런타임 옵션을 구성합니다. |
클래스
| 수업 | 설명 |
|---|---|
| 변화 | 실시간 데이터베이스 또는 Cloud Firestore onWrite 및 onUpdate 이벤트와 같이 상태를 변경하는 이벤트를 위한 Cloud Functions 인터페이스입니다. Change 객체를 구성하는 데 사용되는 형식에 대한 자세한 내용은 아래를 참조하세요. |
| 함수빌더 |
인터페이스
| 상호 작용 | 설명 |
|---|---|
| 차단 기능 | 인증 차단 트리거의 함수 유형입니다. |
| CloudFunction | HTTPS가 아닌 모든 트리거에 대한 함수 유형입니다. Cloud 함수를 정의하려면 JavaScript 파일에서 이를 내보내야 합니다. 이 유형은 템플릿 Event 객체를 유일한 인수로 사용하는 특수 JavaScript 함수입니다. |
| 배포 옵션 | 기능 배포 중에 적용되는 기능에 대한 구성 옵션입니다. |
| 이벤트 | 이벤트의 와이어 형식입니다. |
| 이벤트컨텍스트 | 이벤트가 발생한 컨텍스트입니다. |
| 실패정책 | 백그라운드 기능에 대한 실패 정책에 대한 구성 옵션입니다. |
| Https함수 | HTTPS 트리거의 함수 유형입니다. Cloud 함수를 정의하려면 JavaScript 파일에서 이를 내보내야 합니다. |
| 자원 | Resource는 리소스를 정의하기 위한 표준 형식입니다(google.rpc.context.AttributeContext.Resource). Cloud Functions에서는 스토리지 버킷과 같이 함수를 트리거한 리소스입니다. |
| 실행 가능 | Runnable에는 사용자 정의 함수를 직접 호출하는 run 메서드가 있습니다. 이는 단위 테스트에 유용합니다. |
| 런타임옵션 | 런타임 시 적용 가능한 기능에 대한 구성 옵션입니다. |
| 일정 | 예약된 기능에 대한 구성 옵션입니다. |
| 일정재시도 구성 | 스케줄러 재시도 옵션. 예약된 기능에만 적용됩니다. |
네임스페이스
| 네임스페이스 | 설명 |
|---|---|
| 해석학 | |
| 인증 | |
| 데이터 베이스 | |
| 소방서 | |
| https | |
| 나무꾼 | |
| 매개변수 | |
| 게시자 | |
| 원격 구성 | |
| 저장 | |
| 작업 | |
| 테스트랩 |
변수
| 변하기 쉬운 | 설명 |
|---|---|
| 앱 | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | IngressSettings에 사용 가능한 옵션 목록입니다. |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | Cloud Functions 최대 제한 시간 값입니다. |
| MIN_TIMEOUT_SECONDS | Cloud Functions 최소 제한 시간 값입니다. |
| RESET_VALUE | 구성을 플랫폼 기본값으로 재설정하는 특수 구성 값입니다. |
| 지원_지역 | Cloud Functions에서 지원하는 모든 지역 목록입니다. |
| VALID_MEMORY_OPTIONS | Cloud Functions에서 지원하는 사용 가능한 메모리 옵션 목록입니다. |
| VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectorEgressSettings에 사용 가능한 옵션 목록입니다. |
구성()
타사 API 키 또는 기타 설정과 같은 프로젝트 구성 데이터를 저장하고 검색합니다. [환경 구성](/docs/functions/config-env)에 설명된 대로 Firebase CLI를 사용하여 구성 값을 설정할 수 있습니다.
서명:
export declare function config(): Record<string, any>;
보고:
레코드<문자열, 임의>
optionsToEndpoint()
서명:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 배포 옵션 |
보고:
매니페스트엔드포인트
옵션투트리거()
서명:
export declare function optionsToTrigger(options: DeploymentOptions): any;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 배포 옵션 |
보고:
어느
지역()
함수가 배포되는 지역을 구성합니다.
서명:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 지역 | 배열<( SUPPORTED_REGIONS 유형 )[번호] | 문자열 | 표현 <문자열> | 재설정값> | 추가 지역 문자열 중 하나입니다. |
보고:
실시예 1
function.region('us-east1')
실시예 2
function.region('us-east1', 'us-central1')
실행()
함수에 대한 런타임 옵션을 구성합니다.
서명:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 런타임옵션 | 런타임옵션 | 선택적 필드가 있는 개체: 1. memory : 함수에 할당할 메모리 양, 가능한 값은 '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' 및 '8GB'입니다. . 2. timeoutSeconds : 함수의 시간 초과(초), 가능한 값은 0~540입니다. 3. failurePolicy : 함수의 실패 정책으로, 부울 true 빈 재시도 객체를 제공하는 것과 동일합니다. 4. vpcConnector : 동일한 프로젝트 및 지역에 있는 VPC 커넥터의 ID입니다. 5. vpcConnectorEgressSettings : vpcConnector가 설정되면 vpcConnector를 통해 전송되는 송신 트래픽을 제어합니다. 6. serviceAccount : 해당 기능에 대한 특정 서비스 계정입니다. 7. ingressSettings : HTTPS 함수가 호출될 수 있는 위치를 제어하는 함수에 대한 수신 설정입니다. 값은 null일 수 없습니다. |
보고:
앱
서명:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
서명:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
IngressSettings에 사용 가능한 옵션 목록입니다.
서명:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS
서명:
MAX_NUMBER_USER_LABELS = 58
MAX_TIMEOUT_SECONDS
Cloud Functions 최대 제한 시간 값입니다.
서명:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Cloud Functions 최소 제한 시간 값입니다.
서명:
MIN_TIMEOUT_SECONDS = 0
RESET_VALUE
구성을 플랫폼 기본값으로 재설정하는 특수 구성 값입니다.
서명:
RESET_VALUE: ResetValue
지원_지역
Cloud Functions에서 지원하는 모든 지역 목록입니다.
서명:
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
VALID_MEMORY_OPTIONS
Cloud Functions에서 지원하는 사용 가능한 메모리 옵션 목록입니다.
서명:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
VpcConnectorEgressSettings에 사용 가능한 옵션 목록입니다.
서명:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]