feat: add slice and at (#27)

TomerAberbach · Oct 20, 2024 · acf2130 · acf2130
1 parent fd6e1ff
commit acf2130
Show file tree

Hide file tree

Showing 233 changed files with 6,907 additions and 1,945 deletions.
diff --git a/docs/functions/all.md b/docs/functions/all.md
@@ -66,7 +66,7 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:49](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L49)
+[predicate.d.ts:49](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L49)
 
 ## all(fn, iterable)
 
@@ -105,4 +105,4 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:49](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L49)
+[predicate.d.ts:49](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L49)
diff --git a/docs/functions/allAsync.md b/docs/functions/allAsync.md
@@ -68,7 +68,7 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:69](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L69)
+[predicate.d.ts:69](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L69)
 
 ## allAsync(fn, asyncIterable)
 
@@ -108,4 +108,4 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:69](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L69)
+[predicate.d.ts:69](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L69)
diff --git a/docs/functions/allConcur.md b/docs/functions/allConcur.md
@@ -68,7 +68,7 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:89](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L89)
+[predicate.d.ts:89](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L89)
 
 ## allConcur(fn, concurIterable)
 
@@ -108,4 +108,4 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:89](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L89)
+[predicate.d.ts:89](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L89)
diff --git a/docs/functions/any.md b/docs/functions/any.md
@@ -66,7 +66,7 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:108](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L108)
+[predicate.d.ts:108](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L108)
 
 ## any(fn, iterable)
 
@@ -105,4 +105,4 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:108](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L108)
+[predicate.d.ts:108](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L108)
diff --git a/docs/functions/anyAsync.md b/docs/functions/anyAsync.md
@@ -68,7 +68,7 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:128](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L128)
+[predicate.d.ts:128](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L128)
 
 ## anyAsync(fn, asyncIterable)
 
@@ -108,4 +108,4 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:128](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L128)
+[predicate.d.ts:128](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L128)
diff --git a/docs/functions/anyConcur.md b/docs/functions/anyConcur.md
@@ -68,7 +68,7 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:148](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L148)
+[predicate.d.ts:148](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L148)
 
 ## anyConcur(fn, concurIterable)
 
@@ -108,4 +108,4 @@ console.log(
 
 ### Defined in
 
-[predicate.d.ts:148](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/predicate.d.ts#L148)
+[predicate.d.ts:148](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/predicate.d.ts#L148)
diff --git a/docs/functions/asAsync.md b/docs/functions/asAsync.md
@@ -46,4 +46,4 @@ for await (const value of asyncIterable) {
 
 ## Defined in
 
-[as.d.ts:27](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/as.d.ts#L27)
+[as.d.ts:27](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/as.d.ts#L27)
diff --git a/docs/functions/asConcur.md b/docs/functions/asConcur.md
@@ -35,4 +35,4 @@ await forEachConcur(console.log, concurIterable)
 
 ## Defined in
 
-[as.d.ts:77](https://github.com/TomerAberbach/lfi/blob/e98b31ea37c84de0758cf58c8fcf28193f36b533/src/operations/as.d.ts#L77)
+[as.d.ts:77](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/as.d.ts#L77)
diff --git a/docs/functions/at.md b/docs/functions/at.md
@@ -0,0 +1,138 @@
+[**lfi**](../readme.md) • **Docs**
+
+***
+
+[lfi](../globals.md) / at
+
+# Function: at()
+
+Returns an iterable containing the value at the given `index` of `iterable`
+or an empty iterable if `index` is out of bounds.
+
+WARNING: This function linearly iterates up to `index` because iterables do
+not support random access.
+
+## Throws
+
+if `index` is not a non-negative integer.
+
+## Example
+
+```js
+const iterable = [`sloth`, `more sloth`, `even more sloth`]
+
+console.log(
+  pipe(
+    iterable,
+    at(1),
+    get,
+  ),
+)
+//=> 'more sloth'
+```
+
+## at(index)
+
+> **at**\<`Index`\>(`index`): \<`Value`\>(`iterable`) => [`Optional`](../type-aliases/Optional.md)\<`Value`\>
+
+Returns an iterable containing the value at the given `index` of `iterable`
+or an empty iterable if `index` is out of bounds.
+
+WARNING: This function linearly iterates up to `index` because iterables do
+not support random access.
+
+### Type Parameters
+
+• **Index** *extends* `number`
+
+### Parameters
+
+• **index**: `NonNegativeInteger`\<`Index`\>
+
+### Returns
+
+`Function`
+
+#### Type Parameters
+
+• **Value**
+
+#### Parameters
+
+• **iterable**: `Iterable`\<`Value`, `any`, `any`\>
+
+#### Returns
+
+[`Optional`](../type-aliases/Optional.md)\<`Value`\>
+
+### Throws
+
+if `index` is not a non-negative integer.
+
+### Example
+
+```js
+const iterable = [`sloth`, `more sloth`, `even more sloth`]
+
+console.log(
+  pipe(
+    iterable,
+    at(1),
+    get,
+  ),
+)
+//=> 'more sloth'
+```
+
+### Defined in
+
+[slice.d.ts:706](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/slice.d.ts#L706)
+
+## at(index, iterable)
+
+> **at**\<`Index`, `Value`\>(`index`, `iterable`): [`Optional`](../type-aliases/Optional.md)\<`Value`\>
+
+Returns an iterable containing the value at the given `index` of `iterable`
+or an empty iterable if `index` is out of bounds.
+
+WARNING: This function linearly iterates up to `index` because iterables do
+not support random access.
+
+### Type Parameters
+
+• **Index** *extends* `number`
+
+• **Value**
+
+### Parameters
+
+• **index**: `NonNegativeInteger`\<`Index`\>
+
+• **iterable**: `Iterable`\<`Value`, `any`, `any`\>
+
+### Returns
+
+[`Optional`](../type-aliases/Optional.md)\<`Value`\>
+
+### Throws
+
+if `index` is not a non-negative integer.
+
+### Example
+
+```js
+const iterable = [`sloth`, `more sloth`, `even more sloth`]
+
+console.log(
+  pipe(
+    iterable,
+    at(1),
+    get,
+  ),
+)
+//=> 'more sloth'
+```
+
+### Defined in
+
+[slice.d.ts:709](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/slice.d.ts#L709)
diff --git a/docs/functions/atAsync.md b/docs/functions/atAsync.md
@@ -0,0 +1,138 @@
+[**lfi**](../readme.md) • **Docs**
+
+***
+
+[lfi](../globals.md) / atAsync
+
+# Function: atAsync()
+
+Returns an async iterable containing the value at the given `index` of
+`asyncIterable` or an empty async iterable if `index` is out of bounds.
+
+WARNING: This function linearly iterates up to `index` because async
+iterables do not support random access.
+
+## Throws
+
+if `index` is not a non-negative integer.
+
+## Example
+
+```js
+const asyncIterable = asAsync([`sloth`, `more sloth`, `even more sloth`])
+
+console.log(
+  await pipe(
+    asyncIterable,
+    atAsync(1),
+    getAsync,
+  ),
+)
+//=> 'more sloth'
+```
+
+## atAsync(index)
+
+> **atAsync**\<`Index`\>(`index`): \<`Value`\>(`asyncIterable`) => [`AsyncOptional`](../type-aliases/AsyncOptional.md)\<`Value`\>
+
+Returns an async iterable containing the value at the given `index` of
+`asyncIterable` or an empty async iterable if `index` is out of bounds.
+
+WARNING: This function linearly iterates up to `index` because async
+iterables do not support random access.
+
+### Type Parameters
+
+• **Index** *extends* `number`
+
+### Parameters
+
+• **index**: `NonNegativeInteger`\<`Index`\>
+
+### Returns
+
+`Function`
+
+#### Type Parameters
+
+• **Value**
+
+#### Parameters
+
+• **asyncIterable**: `AsyncIterable`\<`Value`, `any`, `any`\>
+
+#### Returns
+
+[`AsyncOptional`](../type-aliases/AsyncOptional.md)\<`Value`\>
+
+### Throws
+
+if `index` is not a non-negative integer.
+
+### Example
+
+```js
+const asyncIterable = asAsync([`sloth`, `more sloth`, `even more sloth`])
+
+console.log(
+  await pipe(
+    asyncIterable,
+    atAsync(1),
+    getAsync,
+  ),
+)
+//=> 'more sloth'
+```
+
+### Defined in
+
+[slice.d.ts:739](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/slice.d.ts#L739)
+
+## atAsync(index, asyncIterable)
+
+> **atAsync**\<`Index`, `Value`\>(`index`, `asyncIterable`): [`AsyncOptional`](../type-aliases/AsyncOptional.md)\<`Value`\>
+
+Returns an async iterable containing the value at the given `index` of
+`asyncIterable` or an empty async iterable if `index` is out of bounds.
+
+WARNING: This function linearly iterates up to `index` because async
+iterables do not support random access.
+
+### Type Parameters
+
+• **Index** *extends* `number`
+
+• **Value**
+
+### Parameters
+
+• **index**: `NonNegativeInteger`\<`Index`\>
+
+• **asyncIterable**: `AsyncIterable`\<`Value`, `any`, `any`\>
+
+### Returns
+
+[`AsyncOptional`](../type-aliases/AsyncOptional.md)\<`Value`\>
+
+### Throws
+
+if `index` is not a non-negative integer.
+
+### Example
+
+```js
+const asyncIterable = asAsync([`sloth`, `more sloth`, `even more sloth`])
+
+console.log(
+  await pipe(
+    asyncIterable,
+    atAsync(1),
+    getAsync,
+  ),
+)
+//=> 'more sloth'
+```
+
+### Defined in
+
+[slice.d.ts:742](https://github.com/TomerAberbach/lfi/blob/fd6e1ff9d7b7d249090f89ead6d0a30e26aba2e4/src/operations/slice.d.ts#L742)