함수
| 함수 | 설명 |
|---|---|
| config()를 호출하세요. | 서드 파티 API 키 또는 기타 설정과 같은 프로젝트 구성 데이터를 저장하고 가져옵니다. [환경 구성](/docs/functions/config-env)에 설명된 대로 Firebase CLI를 사용하여 구성 값을 설정할 수 있습니다. |
| optionsToEndpoint(옵션) | |
| optionsToTrigger(options) | |
| region(리전) | 함수가 배포되는 리전을 구성합니다. |
| runWith(runtimeOptions)를 | 함수의 런타임 옵션을 구성합니다. |
클래스
| 클래스 | 설명 |
|---|---|
| 변경 | 실시간 데이터베이스 또는 Cloud Firestore onWrite 및 onUpdate 이벤트와 같이 상태를 변경하는 이벤트를 위한 Cloud Functions 인터페이스입니다.Change 객체를 구성하는 데 사용되는 형식에 대한 자세한 내용은 아래를 참조하세요. |
| 함수 빌더 |
인터페이스
| 인터페이스 | 설명 |
|---|---|
| 차단 함수 | 인증 차단 트리거의 함수 유형입니다. |
| Cloud Functions | HTTPS가 아닌 모든 트리거의 함수 유형입니다. Cloud 함수를 정의하려면 JavaScript 파일에서 내보내야 합니다.이 유형은 템플릿 Event 객체를 유일한 인수로 사용하는 특수 JavaScript 함수입니다. |
| 배포 옵션 | 함수 배포 중에 적용되는 함수의 구성 옵션입니다. |
| 이벤트 | 이벤트 전송 형식입니다. |
| EventContext | 이벤트가 발생한 컨텍스트입니다. |
| FailurePolicy | 백그라운드 함수의 실패 정책에 대한 구성 옵션입니다. |
| HttpsFunction | HTTPS 트리거의 함수 유형입니다. Cloud 함수를 정의하려면 JavaScript 파일에서 내보내야 합니다. |
| 리소스 | Resource는 리소스를 정의하기 위한 표준 형식 (google.rpc.context.AttributeContext.Resource)입니다. Cloud Functions에서 함수를 트리거한 리소스(예: 스토리지 버킷)입니다. |
| Runnable | Runnable에는 사용자 정의 함수를 직접 호출하는 run 메서드가 있으며, 이는 단위 테스트에 유용합니다. |
| RuntimeOptions | 런타임에 적용되는 함수의 구성 옵션입니다. |
| 일정 | 예약 함수의 구성 옵션입니다. |
| ScheduleRetryConfig | 스케줄러 재시도 옵션 예약된 함수에만 적용됩니다. |
네임스페이스
| 네임스페이스 | 설명 |
|---|---|
| 분석 | |
| 인증 | |
| 데이터베이스 | |
| firestore | |
| https | |
| 로거 | |
| 매개변수 | |
| Pub | |
| remoteConfig | |
| 스토리지 | |
| 할 일 | |
| testLab |
변수
| 변수 | 설명 |
|---|---|
| app | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | IngressSettings에 사용할 수 있는 옵션의 목록입니다. |
| MAX_NUMBER_USER_LABELS개 | |
| MAX_TIMEOUT_SECONDS초 | Cloud Functions 최대 제한 시간 값입니다. |
| MIN_TIMEOUT_SECONDS초 | Cloud Functions 최소 제한 시간 값입니다. |
| 리셋_값 | 구성을 플랫폼 기본값으로 재설정하는 특수 구성 값입니다. |
| SUPPORTED_REGIONS개 | Cloud Functions에서 지원하는 모든 리전의 목록입니다. |
| VALID_MEMORY_OPTIONS | Cloud Functions에서 지원하는 사용 가능한 메모리 옵션의 목록입니다. |
| VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectorEgressSettings에 사용할 수 있는 옵션의 목록입니다. |
config()
서드 파티 API 키 또는 기타 설정과 같은 프로젝트 구성 데이터를 저장하고 가져옵니다. [환경 구성](/docs/functions/config-env)에 설명된 대로 Firebase CLI를 사용하여 구성 값을 설정할 수 있습니다.
서명:
export declare function config(): Record<string, any>;
반환:
레코드<문자열, 임의>
optionsToEndpoint()
서명:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 배포 옵션 |
반환:
매니페스트 엔드포인트
optionsToTrigger()
서명:
export declare function optionsToTrigger(options: DeploymentOptions): any;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 배포 옵션 |
반환:
모두
지역()
함수가 배포되는 리전을 구성합니다.
서명:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 리전 | 배열<(유형: SUPPORTED_REGIONS)[숫자] | 문자열 | 표현식<string> | 재설정 값> | 지역 문자열 중 하나 이상입니다. |
반환:
예 1
functions.region('us-east1')
예 2
functions.region('us-east1', 'us-central1')
runWith()
함수의 런타임 옵션을 구성합니다.
서명:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 런타임 옵션 | RuntimeOptions | 선택 필드가 있는 객체: 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
최대 시간 초과 초
Cloud Functions 최대 제한 시간 값입니다.
서명:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS초
Cloud Functions 최소 제한 시간 값입니다.
서명:
MIN_TIMEOUT_SECONDS = 0
값 재설정
구성을 플랫폼 기본값으로 재설정하는 특수 구성 값입니다.
서명:
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"]