From aa4cc2079f2e36ead729b9f08f716b3dee5323f4 Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Fri, 27 Sep 2024 12:24:40 +0100 Subject: [PATCH] Adding comment to explain new function. --- packages/server/src/utilities/rowProcessor/index.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/server/src/utilities/rowProcessor/index.ts b/packages/server/src/utilities/rowProcessor/index.ts index f20a95c2fa..2d0098ede6 100644 --- a/packages/server/src/utilities/rowProcessor/index.ts +++ b/packages/server/src/utilities/rowProcessor/index.ts @@ -292,6 +292,12 @@ export async function outputProcessing( return (wasArray ? enriched : enriched[0]) as T } +/** + * This function is similar to the outputProcessing function above, it makes sure that all the provided + * rows are ready for output, but does not have enrichment for squash capabilities which can cause performance issues. + * outputProcessing should be used when responding from the API, while this should be used when internally processing + * rows for any reason (like part of view operations). + */ export async function coreOutputProcessing( table: Table, rows: Row[],