https.CallableFunction interface

Creates a callable method for clients to call using a Firebase SDK.

Signature:

export interface CallableFunction<T, Return, Stream = unknown> extends HttpsFunction 

Extends: HttpsFunction

Methods

https.CallableFunction.run()

Executes the handler function with the provided data as input. Used for unit testing.

Signature:

run(request: CallableRequest<T>): Return;

Parameters

Returns:

Return

The output of the handler function.

https.CallableFunction.stream()

Signature:

stream(request: CallableRequest<T>, response: CallableResponse<Stream>): {
        stream: AsyncIterator<Stream>;
        output: Return;
    };

Parameters

Returns:

{ stream: AsyncIterator<Stream>; output: Return; }