From 02f36c9ee054c586bdc38690c933f3c5e25bfcdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Coye=20de=20Brune=CC=81lis?= Date: Wed, 27 Mar 2024 16:23:55 +0100 Subject: [PATCH] docs: Bump readme for new functions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 8d9e57f..3db66bc 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,18 @@ Well tested. Used in production across Infomaniak's apps written in Swift. - Work will be executed out of order. - Input order __preserved__ in the output result. +- `asyncForEach` + - Shorthand for `concurrentForEach(customConcurrency: 1)` + - __Serially__ loops over a `Collection` to perform an async task on each element. + +- `asyncMap` + - Shorthand for `concurrentMap(customConcurrency: 1)` + - __Serially__ Maps an async task with nullable result. + +- `asyncCompactMap` + - Shorthand for `concurrentCompactMap(customConcurrency: 1)` + - __Serially__ Maps an async task with nullable result, returning only non nil values + ## Behaviour An heuristic determines a degree of __parallelism__ for you, but can be customised. We recommend sticking to a fixed parallelism (1-4ish) when working with network calls.