functions package

Firebase용 Cloud 함수

기능

기능 설명
기능(앱, ...)
getFunctions(앱, 지역또는CustomDomain) 지정된 앱에 대한 Functions 인스턴스를 반환합니다.
함수(함수인스턴스, ...)
connectFunctionsEmulator(functionsInstance, 호스트, 포트) Cloud Functions 에뮬레이터와 통신하도록 이 인스턴스를 수정하세요. 참고: 이 인스턴스를 사용하여 작업을 수행하기 전에 호출해야 합니다.
httpsCallable(functionsInstance, 이름, 옵션) 지정된 이름을 가진 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.
httpsCallableFromURL(functionsInstance, url, 옵션) 지정된 URL을 사용하여 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.

인터페이스

상호 작용 설명
기능 Functions 인스턴스.
기능오류 Firebase Functions 클라이언트 SDK에서 반환한 오류입니다.
HttpsCallable옵션 호출 실행 방법에 대한 메타데이터용 인터페이스입니다.
HttpsCallableResult HttpsCallableResult 는 함수 호출의 단일 결과를 래핑합니다.

유형 별칭

유형 별칭 설명
함수ErrorCode Firebase Functions 상태 코드 집합입니다. 코드는 https://github.com/grpc/grpc/blob/master/doc/statuscodes.md에서 gRPC에 의해 노출된 코드와 동일합니다. 가능한 값: - 'cancelled': 작업이 취소되었습니다(일반적으로 호출자에 의해). - '알 수 없음': 알 수 없는 오류 또는 다른 오류 도메인의 오류입니다. - 'invalid-argument': 클라이언트가 잘못된 인수를 지정했습니다. 이는 '실패한 전제 조건'과 다릅니다. 'invalid-argument'는 시스템 상태(예: 유효하지 않은 필드 이름)와 관계없이 문제가 있는 인수를 나타냅니다. - 'deadline-exceeded': 작업이 완료되기 전에 기한이 만료되었습니다. 시스템 상태를 변경하는 작업의 경우 작업이 성공적으로 완료된 경우에도 이 오류가 반환될 수 있습니다. 예를 들어, 서버의 성공적인 응답은 기한이 만료될 만큼 오랫동안 지연되었을 수 있습니다. - 'not-found': 요청한 일부 문서를 찾을 수 없습니다. - 'already-exists': 생성하려고 시도한 일부 문서가 이미 존재합니다. - 'permission-denied': 호출자에게 지정된 작업을 실행할 수 있는 권한이 없습니다. - 'resource-exhausted': 일부 리소스가 소진되었습니다. 사용자별 할당량이거나 전체 파일 시스템의 공간이 부족할 수 있습니다. - 'failed-precondition': 시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다. - 'aborted': 일반적으로 트랜잭션 중단 등과 같은 동시성 문제로 인해 작업이 중단되었습니다. - 'out-of-range': 유효한 범위를 넘어서 작업이 시도되었습니다. - '구현되지 않음': 작업이 구현되지 않거나 지원/활성화되지 않습니다. - '내부': 내부 오류입니다. 기본 시스템에서 예상되는 일부 불변성이 손상되었음을 의미합니다. 이러한 오류 중 하나가 표시되면 뭔가 매우 손상된 것입니다. - '사용할 수 없음': 현재 서비스를 사용할 수 없습니다. 이는 일시적인 상태일 가능성이 높으며 백오프를 통해 다시 시도하면 해결될 수 있습니다. - 'data-loss': 복구할 수 없는 데이터 손실 또는 손상입니다. - '인증되지 않음': 요청에 작업에 대한 유효한 인증 자격 증명이 없습니다.
함수ErrorCodeCore "functions/" 제품 접두사 뒤에 함수 오류 코드 문자열이 추가됩니다. 코드에 대한 전체 문서는 FunctionsErrorCode를 참조하세요.
Https호출 가능 Google Cloud Functions의 '호출 가능' HTTP 트리거에 대한 참조입니다.

기능(앱, ...)

getFunctions(앱, 지역또는CustomDomain)

지정된 앱에 대한 Functions 인스턴스를 반환합니다.

서명:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

매개변수

매개변수 유형 설명
Firebase앱 사용할 FirebaseApp입니다 .
지역또는맞춤도메인 다음 중 하나: a) 호출 가능 함수가 위치한 지역(예: us-central1) b) 호출 가능 함수를 호스팅하는 사용자 지정 도메인(예: https://mydomain.com)

보고:

기능

함수(함수인스턴스, ...)

connectFunctionsEmulator(functionsInstance, 호스트, 포트)

Cloud Functions 에뮬레이터와 통신하도록 이 인스턴스를 수정하세요.

서명:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

매개변수

매개변수 유형 설명
함수인스턴스 기능
주인 에뮬레이터 호스트(예: localhost)
포트 숫자 에뮬레이터 포트(예: 5001)

보고:

무효의

httpsCallable(functionsInstance, 이름, 옵션)

지정된 이름을 가진 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.

서명:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

매개변수

매개변수 유형 설명
함수인스턴스 기능
이름 트리거의 이름입니다.
옵션 HttpsCallable옵션

보고:

Https호출 가능 <요청데이터, 응답데이터>

httpsCallableFromURL(functionsInstance, url, 옵션)

지정된 URL을 사용하여 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.

서명:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

매개변수

매개변수 유형 설명
함수인스턴스 기능
URL 트리거의 URL입니다.
옵션 HttpsCallable옵션

보고:

Https호출 가능 <요청데이터, 응답데이터>

함수ErrorCode

Firebase Functions 상태 코드 집합입니다. 코드는 https://github.com/grpc/grpc/blob/master/doc/statuscodes.md에서 gRPC에 의해 노출된 코드와 동일합니다.

가능한 값: - 'cancelled': 작업이 취소되었습니다(일반적으로 호출자에 의해). - '알 수 없음': 알 수 없는 오류 또는 다른 오류 도메인의 오류입니다. - 'invalid-argument': 클라이언트가 잘못된 인수를 지정했습니다. 이는 '실패한 전제 조건'과 다릅니다. 'invalid-argument'는 시스템 상태(예: 유효하지 않은 필드 이름)와 관계없이 문제가 있는 인수를 나타냅니다. - 'deadline-exceeded': 작업이 완료되기 전에 기한이 만료되었습니다. 시스템 상태를 변경하는 작업의 경우 작업이 성공적으로 완료된 경우에도 이 오류가 반환될 수 있습니다. 예를 들어, 서버의 성공적인 응답은 기한이 만료될 만큼 오랫동안 지연되었을 수 있습니다. - 'not-found': 요청한 일부 문서를 찾을 수 없습니다. - 'already-exists': 생성하려고 시도한 일부 문서가 이미 존재합니다. - 'permission-denied': 호출자에게 지정된 작업을 실행할 수 있는 권한이 없습니다. - 'resource-exhausted': 일부 리소스가 소진되었습니다. 사용자별 할당량이거나 전체 파일 시스템의 공간이 부족할 수 있습니다. - 'failed-precondition': 시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다. - 'aborted': 일반적으로 트랜잭션 중단 등과 같은 동시성 문제로 인해 작업이 중단되었습니다. - 'out-of-range': 유효한 범위를 넘어서 작업이 시도되었습니다. - '구현되지 않음': 작업이 구현되지 않거나 지원/활성화되지 않습니다. - '내부': 내부 오류입니다. 기본 시스템에서 예상되는 일부 불변성이 손상되었음을 의미합니다. 이러한 오류 중 하나가 표시되면 뭔가 매우 손상된 것입니다. - '사용할 수 없음': 현재 서비스를 사용할 수 없습니다. 이는 일시적인 상태일 가능성이 높으며 백오프를 통해 다시 시도하면 해결될 수 있습니다. - 'data-loss': 복구할 수 없는 데이터 손실 또는 손상입니다. - '인증되지 않음': 요청에 작업에 대한 유효한 인증 자격 증명이 없습니다.

서명:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

함수ErrorCodeCore

"functions/" 제품 접두사 뒤에 함수 오류 코드 문자열이 추가됩니다. 코드에 대한 전체 문서는 FunctionsErrorCode를 참조하세요.

서명:

export declare type FunctionsErrorCodeCore = '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';

Https호출 가능

Google Cloud Functions의 '호출 가능' HTTP 트리거에 대한 참조입니다.

서명:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;