https namespace

기능

기능 설명
onCall(핸들러) 클라이언트가 Firebase SDK를 사용하여 호출할 수 있는 호출 가능한 메서드를 선언합니다.
onRequest(핸들러) HTTP 요청을 처리합니다.

클래스

수업 설명
Https오류 함수를 호출한 클라이언트에 오류를 보내기 위해 핸들러에서 발생할 수 있는 명시적 오류입니다.

인터페이스

상호 작용 설명
호출 가능 컨텍스트 핸들러에 전달된 API의 메타데이터에 대한 인터페이스입니다.
요구 요청 본문을 유선 형식으로 표현한 명시적 요청입니다.

유형 별칭

유형 별칭 설명
함수ErrorCode Firebase Functions 상태 코드 집합입니다. 코드는 gRPC 에서 노출된 코드와 동일합니다. .

https.onCall()

클라이언트가 Firebase SDK를 사용하여 호출할 수 있는 호출 가능한 메서드를 선언합니다.

서명:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

매개변수

매개변수 유형 설명
매니저 (데이터: 임의, 컨텍스트: CallableContext ) => 모두 | 약속<아무거나> 데이터와 컨텍스트를 가져와 값을 반환하는 메서드입니다.

보고:

Https함수실행 가능 <아무거나>

https.onRequest()

HTTP 요청을 처리합니다.

서명:

export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;

매개변수

매개변수 유형 설명
매니저 (req: 요청, resp: express.Response) => void | 약속<공허> Express 앱과 동일한 서명인 요청 및 응답 개체를 사용하는 함수입니다.

보고:

Https함수

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";