From 6e4f24827bc2e0783c4c550a8cd01b1ae2c4af81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=9C=A8=20Audrey=20=E2=9C=A8?= Date: Tue, 29 Apr 2025 16:15:30 -0400 Subject: [PATCH] comment tweak --- libs/common/src/tools/rx.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/libs/common/src/tools/rx.ts b/libs/common/src/tools/rx.ts index 5fb4bba1e05..4c9e547d151 100644 --- a/libs/common/src/tools/rx.ts +++ b/libs/common/src/tools/rx.ts @@ -248,12 +248,14 @@ export function pin(options?: { ); } -/** maps a value to a source and keeps a LRC cache of the results +/** maps a value to a result and keeps a cache of the mapping * @param mapResult - maps the stream to a result; this function must return * a value. It must not return null or undefined. * @param options.size - the number of entries in the cache * @param options.key - maps the source to a cache key - * @remarks - LRC is least recently created + * @remarks this method is useful for optimization of expensive + * `mapResult` calls. It's also useful when an interned reference type + * is needed. */ export function memoizedMap>( mapResult: (source: Source) => Result,