Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(series module): add search terms and popular use cases #224

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(series module): add search terms and popular use cases #224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/series/series.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,13 @@ const weekdays = _.series<Weekday>(
weekdays.next({ day: 'wednesday' }) // => { day: 'thursday' }
weekdays.previous({ day: 'tuesday' }) // => { day: 'monday' }
```

### Search terms

- Often called `createSeries`, `orderedList`, or `sequenceManager`.

### Popular use cases

- Managing ordered data sequences like lists of dates, numbers, or names, allowing for seamless navigation between values in the sequence.
- Efficiently finding the next or previous value in a list based on the current item, making it ideal for scenarios like calendar date navigation or pagination.
- Handling circular sequences with the `spin` function to dynamically jump forward or backward across items, perfect for rotating selections or cyclic data processing.
Loading