feat(doc): add dedicated page for listing helpers, grouped by packages+categories

This commit is contained in:
Samuel Berthe
2025-10-06 17:11:24 +02:00
parent 70706ca616
commit d4709efc80
30 changed files with 655 additions and 0 deletions

View File

@@ -0,0 +1,8 @@
{
"label": "🧢 Core",
"position": 1,
"link": {
"type": "generated-index",
"description": "Stop reinventing the wheel"
}
}

24
docs/docs/core/channel.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Channel"
description: Loop over channel and perform transformations
sidebar_position: 20
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Channel helpers
This page lists all operations on channels, available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="channel"
/>

View File

@@ -0,0 +1,24 @@
---
title: "Concurrency"
description: Operate on multiple gorountines
sidebar_position: 80
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Concurrency helpers
This page lists all concurrency operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="concurrency"
/>

View File

@@ -0,0 +1,24 @@
---
title: "Condition"
description: Perform transformations on types
sidebar_position: 45
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Conditional helpers
This page lists all conditional operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="condition"
/>

View File

@@ -0,0 +1,24 @@
---
title: "Error handling"
description: Error handling
sidebar_position: 110
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Error handling helpers
This page lists all error handling operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="error-handling"
/>

24
docs/docs/core/find.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Find"
description: Loop over a collection and find element(s)
sidebar_position: 40
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Find helpers
This page lists all search helpers, available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="find"
/>

View File

@@ -0,0 +1,24 @@
---
title: "Function"
description: Functions helpers
sidebar_position: 30
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Function helpers
This page lists all operations on functions, available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="function"
/>

View File

@@ -0,0 +1,24 @@
---
title: "Intersect"
description: Loop over a collection and find similar items
sidebar_position: 50
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Intersection helpers
This page lists all intersection helpers, available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="intersect"
/>

24
docs/docs/core/map.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Map"
description: Loop over maps and perform transformations
sidebar_position: 10
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Map helpers
This page lists all operations on maps, available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="map"
/>

24
docs/docs/core/math.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Math"
description: Perform math operations on collections
sidebar_position: 60
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Math helpers
This page lists all math operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="math"
/>

24
docs/docs/core/retry.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Retry"
description: Retry processing on error
sidebar_position: 70
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Math helpers
This page lists all retry operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="retry"
/>

24
docs/docs/core/slice.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Slice
description: Loop over slices and perform transformations
sidebar_position: 0
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Slice helpers
This page lists all operations on slices, available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="slice"
/>

24
docs/docs/core/string.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "String"
description: Perform transformations on strings
sidebar_position: 35
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## String helpers
This page lists all string operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="string"
/>

24
docs/docs/core/time.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Time"
description: Time manipulation
sidebar_position: 100
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Time helpers
This page lists all time operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="time"
/>

24
docs/docs/core/tuple.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Tuple"
description: Manipulate multiple items in a single variable
sidebar_position: 90
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Tuple helpers
This page lists all tuple operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="tuple"
/>

24
docs/docs/core/type.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: "Type manipulation"
description: Perform transformations on types
sidebar_position: 120
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Type manipulation helpers
This page lists all type operations available in the core package of lo.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="core"
subCategory="type"
/>

View File

@@ -0,0 +1,8 @@
{
"label": "🔄 Iterator",
"position": 2,
"link": {
"type": "generated-index",
"description": "Manipulate iterators over slices, maps, and channels"
}
}

24
docs/docs/iter/channel.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Channel
description: Iterate over channel and perform transformations
sidebar_position: 30
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Channel helpers
This page lists all operations on channels, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="channel"
/>

24
docs/docs/iter/find.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Find
description: Iterate over a collection and find element(s)
sidebar_position: 50
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Find helpers
This page lists all search helpers, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="find"
/>

View File

@@ -0,0 +1,24 @@
---
title: Intersect
description: Iterate over a collection and find similar items
sidebar_position: 60
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Intersection helpers
This page lists all intersection helpers, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="intersect"
/>

24
docs/docs/iter/map.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Map
description: Iterate over maps and perform transformations
sidebar_position: 10
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Map helpers
This page lists all operations on maps, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="map"
/>

View File

@@ -0,0 +1,24 @@
---
title: Sequence
description: Iterate over sequences and perform transformations
sidebar_position: 20
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Sequence helpers
This page lists all operations on sequences, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="sequence"
/>

24
docs/docs/iter/slice.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Slice
description: Iterate over slices and perform transformations
sidebar_position: 0
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Map helpers
This page lists all operations on slice, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="slice"
/>

24
docs/docs/iter/string.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: String
description: Perform transformations on strings
sidebar_position: 40
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## String helpers
This page lists all operations on strings, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="string"
/>

24
docs/docs/iter/tuple.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Tuple
description: Manipulate multiple items in a single variable
sidebar_position: 70
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Tuple helpers
This page lists all tuple operations, available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="tuple"
/>

24
docs/docs/iter/type.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Type manipulation
description: Perform transformations on types
sidebar_position: 80
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Type manipulation helpers
This page lists all type operations available in the `it` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="it"
subCategory="type"
/>

View File

@@ -0,0 +1,8 @@
{
"label": "👣 Mutable",
"position": 3,
"link": {
"type": "generated-index",
"description": "Mutable operations on slices, maps, and channels"
}
}

View File

@@ -0,0 +1,23 @@
---
title: Slice
description: Update slices in place
sidebar_position: 0
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Slice helpers
This page lists all operations on slices, available in the `mutable` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="mutable"
subCategory="slice"
/>

View File

@@ -0,0 +1,8 @@
{
"label": "🏎️ Parallel",
"position": 4,
"link": {
"type": "generated-index",
"description": "Parallel processing of slices, maps, and channels"
}
}

View File

@@ -0,0 +1,24 @@
---
title: Slice
description: Loop over slices and perform transformations in parallel
sidebar_position: 0
hide_table_of_contents: true
---
:::warning Help improve this documentation
This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please [open an issue](https://github.com/samber/lo/issues).
Your feedback helps us improve!
:::
#
## Map helpers
This page lists all operations on slices, available in the `parallel` lo sub-package.
import HelperList from '@site/plugins/helpers-pages/components/HelperList';
<HelperList
category="parallel"
subCategory="slice"
/>