functions package

Firebase용 Cloud Functions

함수

함수 설명
function(앱, ...)
getFunctions(앱, regionOrCustomDomain) 지정된 앱의 Functions 인스턴스를 반환합니다.
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, port) Cloud Functions 에뮬레이터와 통신하도록 이 인스턴스를 수정하세요.참고: 이 인스턴스는 작업을 실행하는 데 사용되기 전에 호출해야 합니다.
httpsCallable(functionsInstance, name, options) 지정된 이름의 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.
httpsCallableFromURL(functionsInstance, url, options) 지정된 URL과 함께 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.

인터페이스

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

유형 별칭

별칭 입력 설명
FunctionsErrorCode Firebase Functions 상태 코드 집합입니다. 코드는 여기 (https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)에 표시된 코드와 동일합니다.가능한 값: - 'cancelled': 작업이 취소되었습니다. 대개 호출자에 의해 취소됩니다. - '알 수 없음': 알 수 없는 오류 또는 다른 오류 도메인에서 오류가 발생했습니다. - 'invalid-argument': 클라이언트가 잘못된 인수를 지정했습니다. 이는 'failed-precondition'과 다릅니다. '잘못된 인수' 는 시스템 상태와 관계없이 문제가 있는 인수를 나타냅니다 (예: 잘못된 필드 이름). - '기한 초과': 작업을 완료하기 전에 기한이 지났습니다. 작업에서 시스템의 상태를 변경하는 경우 작업이 정상적으로 완료되었어도 이 오류가 반환될 수 있습니다. 예를 들어 서버의 성공 응답이 오래 지연되어 기한이 지났을 수 있습니다. - '찾을 수 없음': 요청한 일부 문서를 찾을 수 없습니다. - '이미 존재': 만들려는 일부 문서가 이미 존재합니다. - 'permission-denied': 호출자가 지정된 작업을 실행할 권한이 없습니다. - '리소스 소진': 일부 리소스가 소진되었습니다. 사용자당 할당량이나 전체 파일 시스템의 공간이 부족할 수 있습니다. - 'failed-precondition': 시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다. - 'aborted': 작업이 취소되었습니다. 일반적으로 트랜잭션 취소 등의 동시 실행 문제로 인해 발생합니다. - '범위 밖': 유효한 범위를 넘어 작업을 시도했습니다. - 'unImplemented(구현되지 않음)': 작업이 구현되지 않거나 지원되지 않거나 사용 설정되지 않습니다. - 'internal': 내부 오류입니다. 기본 시스템에서 예상하는 일부 불변 항목이 손상되었음을 의미합니다. 이 오류가 표시된다면 크게 손상된 항목이 있는 것입니다. - '사용할 수 없음': 현재 서비스를 사용할 수 없습니다. 일시적인 상태일 가능성이 높으며 백오프로 다시 시도하면 해결될 수 있습니다. - 'data-loss': 복구할 수 없는 데이터 손실 또는 손상입니다. - 'unauthenticated': 요청에 작업에 대한 올바른 사용자 인증 정보가 없습니다.
FunctionsErrorCodeCore 'functions/' 뒤에 추가된 함수 오류 코드 문자열 제품 접두사로 대체합니다. 코드에 관한 전체 문서는 FunctionsErrorCode를 참고하세요.
HttpsCallable 'callable' 참조 Google Cloud Functions의 HTTP 트리거

함수(앱, ...)

getFunctions(앱, regionOrCustomDomain)

지정된 앱의 Functions 인스턴스를 반환합니다.

서명:

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

매개변수

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

반환:

함수

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, 호스트, 포트)

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

서명:

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

매개변수

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

반환:

void

httpsCallable(functionsInstance, name, options)

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

서명:

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

매개변수

매개변수 유형 설명
함수 인스턴스 함수
name 문자열 트리거의 이름입니다.
옵션 HttpsCallableOptions

반환:

HttpsCallable<RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

지정된 URL과 함께 호출 가능한 HTTPS 트리거에 대한 참조를 반환합니다.

서명:

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

매개변수

매개변수 유형 설명
함수 인스턴스 함수
url 문자열 트리거의 URL입니다.
옵션 HttpsCallableOptions

반환:

HttpsCallable<RequestData, ResponseData>

FunctionsErrorCode

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

가능한 값: - 'cancelled': 작업이 취소되었습니다 (일반적으로 호출자에 의해 취소됨). - '알 수 없음': 알 수 없는 오류 또는 다른 오류 도메인에서 오류가 발생했습니다. - 'invalid-argument': 클라이언트가 잘못된 인수를 지정했습니다. 이는 'failed-precondition'과 다릅니다. '잘못된 인수' 는 시스템 상태와 관계없이 문제가 있는 인수를 나타냅니다 (예: 잘못된 필드 이름). - '기한 초과': 작업을 완료하기 전에 기한이 지났습니다. 작업에서 시스템의 상태를 변경하는 경우 작업이 정상적으로 완료되었어도 이 오류가 반환될 수 있습니다. 예를 들어 서버의 성공 응답이 오래 지연되어 기한이 지났을 수 있습니다. - '찾을 수 없음': 요청한 일부 문서를 찾을 수 없습니다. - '이미 존재': 만들려는 일부 문서가 이미 존재합니다. - 'permission-denied': 호출자가 지정된 작업을 실행할 권한이 없습니다. - '리소스 소진': 일부 리소스가 소진되었습니다. 사용자당 할당량이나 전체 파일 시스템의 공간이 부족할 수 있습니다. - 'failed-precondition': 시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다. - 'aborted': 작업이 취소되었습니다. 일반적으로 트랜잭션 취소 등의 동시 실행 문제로 인해 발생합니다. - '범위 밖': 유효한 범위를 넘어 작업을 시도했습니다. - 'unImplemented(구현되지 않음)': 작업이 구현되지 않거나 지원되지 않거나 사용 설정되지 않습니다. - 'internal': 내부 오류입니다. 기본 시스템에서 예상하는 일부 불변 항목이 손상되었음을 의미합니다. 이 오류가 표시된다면 크게 손상된 항목이 있는 것입니다. - '사용할 수 없음': 현재 서비스를 사용할 수 없습니다. 일시적인 상태일 가능성이 높으며 백오프로 다시 시도하면 해결될 수 있습니다. - 'data-loss': 복구할 수 없는 데이터 손실 또는 손상입니다. - 'unauthenticated': 요청에 작업에 대한 올바른 사용자 인증 정보가 없습니다.

서명:

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

함수 오류 코드 코어

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

HttpsCallable

'callable' 참조 Google Cloud Functions의 HTTP 트리거

서명:

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