함수
| 함수 | 설명 |
|---|---|
| onDocumentCreated(문서, 핸들러) | Firestore에서 문서가 생성될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentCreated(opts, 핸들러) | Firestore에서 문서가 생성될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentDELETE(문서, 핸들러) | Firestore에서 문서가 삭제될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentDELETE(opts, 핸들러) | Firestore에서 문서가 삭제될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentUpdated(문서, 핸들러) | Firestore에서 문서가 업데이트될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentUpdated(opts, 핸들러) | Firestore에서 문서가 업데이트될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentWrite(문서, 핸들러) | Firestore에서 문서가 생성, 업데이트 또는 삭제될 때 트리거되는 이벤트 핸들러입니다. |
| onDocumentWriter(opts, 핸들러) | Firestore에서 문서가 생성, 업데이트 또는 삭제될 때 트리거되는 이벤트 핸들러입니다. |
클래스
| 클래스 | 설명 |
|---|---|
| 변경 | 실시간 데이터베이스 또는 Cloud Firestore onWrite 및 onUpdate 이벤트와 같이 상태를 변경하는 이벤트를 위한 Cloud Functions 인터페이스입니다.Change 객체를 구성하는 데 사용되는 형식에 대한 자세한 내용은 아래를 참조하세요. |
인터페이스
| 인터페이스 | 설명 |
|---|---|
| DocumentOptions. | DocumentOptions는 제공된 문서와 선택적 데이터베이스 및 네임스페이스를 사용하여 EventHandlerOptions를 확장합니다. |
| FirestoreEvent | DocumentSnapshot 또는 변경사항이 포함된 CloudEvent |
유형 별칭
| 별칭 입력 | 설명 |
|---|---|
| DocumentSnapshot | Firestore DocumentSnapshot |
| QueryDocumentSnapshot | Firestore QueryDocumentSnapshot |
Firestore.onDocumentCreated()
Firestore에서 문서가 생성될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 문서 | 문서 | 트리거할 Firestore 문서 경로입니다. |
| handler | (이벤트: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore가 생성될 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<QueryDocumentSnapshot | 정의되지 않음, ParamsOf<Document>>>
Firestore.onDocumentCreated()
Firestore에서 문서가 생성될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 최적화 | DocumentOptions<문서> | 개별 이벤트 처리 함수에서 설정할 수 있는 옵션입니다. |
| handler | (이벤트: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore가 생성될 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<QueryDocumentSnapshot | 정의되지 않음, ParamsOf<Document>>>
Firestore.onDocumentRemove()
Firestore에서 문서가 삭제될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 문서 | 문서 | 트리거할 Firestore 문서 경로입니다. |
| handler | (이벤트: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore 삭제가 발생할 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<QueryDocumentSnapshot | 정의되지 않음, ParamsOf<Document>>>
Firestore.onDocumentRemove()
Firestore에서 문서가 삭제될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 최적화 | DocumentOptions<문서> | 개별 이벤트 처리 함수에서 설정할 수 있는 옵션입니다. |
| handler | (이벤트: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore 삭제가 발생할 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<QueryDocumentSnapshot | 정의되지 않음, ParamsOf<Document>>>
Firestore.onDocumentUpdated()
Firestore에서 문서가 업데이트될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 문서 | 문서 | 트리거할 Firestore 문서 경로입니다. |
| handler | (이벤트: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore가 업데이트될 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | 정의되지 않음, ParamsOf<문서>>>
Firestore.onDocumentUpdated()
Firestore에서 문서가 업데이트될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 최적화 | DocumentOptions<문서> | 개별 이벤트 처리 함수에서 설정할 수 있는 옵션입니다. |
| handler | (이벤트: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore가 업데이트될 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | 정의되지 않음, ParamsOf<문서>>>
Firestore.onDocumentWrite()
Firestore에서 문서가 생성, 업데이트 또는 삭제될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 문서 | 문서 | 트리거할 Firestore 문서 경로입니다. |
| handler | (이벤트: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore가 생성, 업데이트 또는 삭제될 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | 정의되지 않음, ParamsOf<문서>>>
Firestore.onDocumentWrite()
Firestore에서 문서가 생성, 업데이트 또는 삭제될 때 트리거되는 이벤트 핸들러입니다.
서명:
export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 최적화 | DocumentOptions<문서> | 개별 이벤트 처리 함수에서 설정할 수 있는 옵션입니다. |
| handler | (이벤트: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => 모두 | 약속<any> | Firestore가 생성, 업데이트 또는 삭제될 때마다 실행되는 이벤트 핸들러입니다. |
반환:
CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | 정의되지 않음, ParamsOf<문서>>>
Firestore.DocumentSnapshot
Firestore DocumentSnapshot
서명:
export type DocumentSnapshot = firestore.DocumentSnapshot;
Firestore.QueryDocumentSnapshot
Firestore QueryDocumentSnapshot
서명:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;