The request used to call a callable function.
Signature:
export interface CallableRequest<T = any>
Properties
| Property | Type | Description |
|---|---|---|
| acceptsStreaming | boolean | Whether this is a streaming request. Code can be optimized by not trying to generate a stream of chunks to call response.sendChunk on if request.acceptsStreaming is false. It is always safe, however, to call response.sendChunk as this will noop if acceptsStreaming is false. |
| app | AppCheckData | The result of decoding and verifying a Firebase AppCheck token. |
| auth | AuthData | The result of decoding and verifying a Firebase Auth ID token. |
| data | T | The parameters used by a client when calling this function. |
| instanceIdToken | string | An unverified token for a Firebase Instance ID. |
| rawRequest | Request | The raw request handled by the callable. |
https.CallableRequest.acceptsStreaming
Whether this is a streaming request. Code can be optimized by not trying to generate a stream of chunks to call response.sendChunk on if request.acceptsStreaming is false. It is always safe, however, to call response.sendChunk as this will noop if acceptsStreaming is false.
Signature:
acceptsStreaming: boolean;
https.CallableRequest.app
The result of decoding and verifying a Firebase AppCheck token.
Signature:
app?: AppCheckData;
https.CallableRequest.auth
The result of decoding and verifying a Firebase Auth ID token.
Signature:
auth?: AuthData;
https.CallableRequest.data
The parameters used by a client when calling this function.
Signature:
data: T;
https.CallableRequest.instanceIdToken
An unverified token for a Firebase Instance ID.
Signature:
instanceIdToken?: string;
https.CallableRequest.rawRequest
The raw request handled by the callable.
Signature:
rawRequest: Request;