함수
| 함수 | 설명 |
|---|---|
| onCall(핸들러) | 클라이언트가 Firebase SDK를 사용하여 호출할 수 있는 호출 가능 메서드를 선언합니다. |
| onRequest(핸들러) | HTTP 요청을 처리합니다. |
클래스
| 클래스 | 설명 |
|---|---|
| HttpsError: | 함수를 호출한 클라이언트에 오류를 전송하기 위해 핸들러에서 발생할 수 있는 명시적 오류입니다. |
인터페이스
| 인터페이스 | 설명 |
|---|---|
| CallableContext를 | 핸들러에 전달되는 API의 메타데이터에 대한 인터페이스입니다. |
| 요청 | 요청 본문의 와이어 형식 표현을 사용한 빠른 요청입니다. |
유형 별칭
| 별칭 입력 | 설명 |
|---|---|
| FunctionsErrorCode | Firebase Functions 상태 코드 집합입니다. 이 코드는 gRPC에서 노출된 코드와 동일합니다. |
https.onCall()
클라이언트가 Firebase SDK를 사용하여 호출할 수 있는 호출 가능 메서드를 선언합니다.
서명:
export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| handler | (데이터: 모든, 컨텍스트: CallableContext) => 모두 | 약속<any> | 데이터와 컨텍스트를 가져와 값을 반환하는 메서드입니다. |
반환:
HttpsFunction 및 실행 가능<임의>
https.onRequest()
HTTP 요청을 처리합니다.
서명:
export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| handler | (요청: 요청, resp: express.Response) => 무효 | 프로미스<void> | Express 앱과 동일한 서명 및 요청 및 응답 객체를 사용하는 함수입니다. |
반환:
https.FunctionsErrorCode
Firebase Functions 상태 코드 집합입니다. 이 코드는 gRPC에서 노출된 코드와 동일합니다.
가능한 값은 다음과 같습니다.
cancelled: 작업이 취소되었습니다. 대개 호출자에 의해 취소됩니다.unknown: 알 수 없는 오류 또는 다른 오류 도메인의 오류가 발생했습니다.invalid-argument: 클라이언트가 잘못된 인수를 지정했습니다. 이는failed-precondition와 다르다는 점에 유의하세요.invalid-argument는 시스템 상태와 관계없이 문제가 있는 인수를 나타냅니다 (예: 잘못된 필드 이름).deadline-exceeded: 작업을 완료하기 전에 기한이 지났습니다. 작업에서 시스템의 상태를 변경하는 경우 작업이 정상적으로 완료되었어도 이 오류가 반환될 수 있습니다. 예를 들어 서버의 성공 응답이 오래 지연되어 기한이 지났을 수 있습니다.not-found: 요청한 일부 문서를 찾을 수 없습니다.already-exists: 만들려는 일부 문서가 이미 존재합니다.permission-denied: 호출자에게 지정된 작업을 실행할 권한이 없습니다.resource-exhausted: 일부 리소스가 소진되었습니다. 사용자당 할당량이나 전체 파일 시스템의 공간이 부족하기 때문일 수 있습니다.failed-precondition: 시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다.aborted: 작업이 취소되었습니다. 일반적으로 트랜잭션 취소 등의 동시 실행 문제로 인해 발생합니다.out-of-range: 유효한 범위를 벗어나는 작업을 시도했습니다.unimplemented: 작업이 구현되지 않았거나 지원되지 않거나 사용 설정되지 않았습니다.internal: 내부 오류입니다. 기본 시스템에서 예상하는 일부 불변 항목이 손상되었음을 의미합니다. 이 오류가 표시된다면 크게 손상된 항목이 있는 것입니다.unavailable: 현재 서비스를 사용할 수 없습니다. 일시적인 상태일 가능성이 높으며 백오프로 다시 시도하면 해결될 수 있습니다.data-loss: 복구할 수 없는 데이터 손실 또는 손상이 발생했습니다.unauthenticated: 요청에 작업에 대한 유효한 사용자 인증 정보가 없습니다.
서명:
export type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";