summaryrefslogtreecommitdiff
path: root/std/async/README.md
diff options
context:
space:
mode:
authorCasper Beyer <caspervonb@pm.me>2021-02-02 19:05:46 +0800
committerGitHub <noreply@github.com>2021-02-02 12:05:46 +0100
commit6abf126c2a7a451cded8c6b5e6ddf1b69c84055d (patch)
treefd94c013a19fcb38954844085821ec1601c20e18 /std/async/README.md
parenta2b5d44f1aa9d64f448a2a3cc2001272e2f60b98 (diff)
chore: remove std directory (#9361)
This removes the std folder from the tree. Various parts of the tests are pretty tightly dependent on std (47 direct imports and 75 indirect imports, not counting the cli tests that use them as fixtures) so I've added std as a submodule for now.
Diffstat (limited to 'std/async/README.md')
-rw-r--r--std/async/README.md85
1 files changed, 0 insertions, 85 deletions
diff --git a/std/async/README.md b/std/async/README.md
deleted file mode 100644
index 2c2ca1018..000000000
--- a/std/async/README.md
+++ /dev/null
@@ -1,85 +0,0 @@
-# async
-
-async is a module to provide help with asynchronous tasks.
-
-# Usage
-
-The following functions and class are exposed in `mod.ts`:
-
-## deferred
-
-Create a Promise with the `reject` and `resolve` functions.
-
-```typescript
-import { deferred } from "https://deno.land/std/async/mod.ts";
-
-const p = deferred<number>();
-// ...
-p.resolve(42);
-```
-
-## delay
-
-Resolve a Promise after a given amount of milliseconds.
-
-```typescript
-import { delay } from "https://deno.land/std/async/mod.ts";
-
-// ...
-const delayedPromise = delay(100);
-const result = await delayedPromise;
-// ...
-```
-
-## MuxAsyncIterator
-
-The MuxAsyncIterator class multiplexes multiple async iterators into a single
-stream.
-
-The class makes an assumption that the final result (the value returned and not
-yielded from the iterator) does not matter. If there is any result, it is
-discarded.
-
-```typescript
-import { MuxAsyncIterator } from "https://deno.land/std/async/mod.ts";
-
-async function* gen123(): AsyncIterableIterator<number> {
- yield 1;
- yield 2;
- yield 3;
-}
-
-async function* gen456(): AsyncIterableIterator<number> {
- yield 4;
- yield 5;
- yield 6;
-}
-
-const mux = new MuxAsyncIterator<number>();
-mux.add(gen123());
-mux.add(gen456());
-for await (const value of mux) {
- // ...
-}
-// ..
-```
-
-## pooledMap
-
-Transform values from an (async) iterable into another async iterable. The
-transforms are done concurrently, with a max concurrency defined by the
-poolLimit.
-
-```typescript
-import { pooledMap } from "https://deno.land/std/async/mod.ts";
-
-const results = pooledMap(
- 2,
- [1, 2, 3],
- (i) => new Promise((r) => setTimeout(() => r(i), 1000)),
-);
-
-for await (const value of results) {
- // ...
-}
-```