Define Input and Output Parameters for Cloud Function Using Typescript

Question

I am using Firebase Cloud Functions to execute server-side code when called by client via React app. I have many different functions, each of which takes different input parameters, and return a data object with various attributes.

I would like to create a hook called useFirebaseFunctions.ts using which I can make the request, and in doing so, see all the input parameters that function requires, and the expected output results.

Within my hook, I've written the following function:

async function generateReport({ organisationId, projectId }: {
    organisationId: string;
    projectId: string;
}): Promise<{
    data: {
        id: string;
        fileName: string;
        numOfRows: number;
        createdOn: number;
    };
}> {
    const request = httpsCallable(functions, 'adminFunctions-generateReport');
    return request({ organisationId, projectId });
}

For the adminFunctions-generateReport function, the parameters are:

Input	Output
organisationId: string	id: string
projectId: string	fileName: string
	numOfRows: number
	createdOn: number

Issue

However, TypeScript displays an error on the return request({...)}; line:

Type 'HttpsCallableResult' is not assignable to type '{ data: { id: string; fileName: string; numOfRows: number; createdOn: number; }; }'. Types of property 'data' are incompatible. Type '{}' is missing the following properties from type '{ id: string; fileName: string; numOfRows: number; createdOn: number; }': id, fileName, numOfRows, createdOn

How can I properly type the function to get expected behaviour without errors?

Sam · Accepted Answer · 2022-12-05 13:25:23Z

1

I found the solution. I re-declared the function as:

async function generateReport({ ...params }: {
    organisationId: string;
    projectId: string;
}) {
    interface ResInterface {
        id: string;
        fileName: string;
        numOfRows: number;
        createdOn: number;
    };

    const response = httpsCallable<any, ResInterface>(functions, 'adminFunctions-generateReport');
    return (await response({ ...params })).data;
};

edited Dec 5, 2022 at 13:25

answered Dec 5, 2022 at 12:54

Sam

1,23022 silver badges48 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Define Input and Output Parameters for Cloud Function Using Typescript

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related