event-response
When you use Cloud Functions's Background Functions, have you ever wanted to record success / failure respond to the client side that it succeeded?
event-response is easy to understand like success status of HTTP and can record success / failure. It is also possible to handle it on the client side using the recorded status.
Install
yarn install event-response
Overview
OK
When Cloud Functions completes successfully, call setOK()
.
It is 200 in http.
new EventResponse.Resultuser, 'prefix'.setOK
Bad Request
When Cloud Functions fails on client side problems such as invalid parameters, call setBadRequest()
. And you can set id
, error
.
It is 400 in http.
new EventResponse.Resultuser, 'prefix'.setBadRequest'error_id', 'error reason'
Inernal Error
If an error occurs on the server side, call setInternalError
. And you can set id
, error
.
It is 500 in http.
new EventResponse.Resultuser, 'prefix'.setInternalError'error_id', 'error reason'
Usage
This sample is written in TypeScript.
1. Initialize
Initialize event-response in your index.ts.
EventResponse.initializefunctions.config.firebase
2. Call set method
You can set 3 pattens.
- OK
- BadRequest
- InternalError
exports.updateUser = functions.firestore.document'users/{userId}' .onCreate
The result can be got as follows.
admin.firestore.doc'user/1000'.get.then
Advanced
Failure
TODO