ruidy/underscore
1
0
Fork 0
mirror of https://github.com/rjNemo/underscore synced 2026-06-06 02:26:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

reformat readme

Browse source
This commit is contained in:
Ruidy 2024-09-08 19:14:07 +02:00
parent eda818c6e0
commit 78b90acc67
No known key found for this signature in database
GPG key ID: E00F51288CB857CC
1 changed files with 32 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -1,4 +1,4 @@
# _Underscore
# \_Underscore
![License](https://img.shields.io/github/license/rjNemo/underscore?style=for-the-badge)
[![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge&logo=go)](https://pkg.go.dev/github.com/rjNemo/underscore)
@ -7,9 +7,11 @@
![underscore](https://socialify.git.ci/rjNemo/underscore/image?description=1&font=KoHo&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2FrjNemo%2Funderscore%2Fmain%2Fdocs%2Fstatic%2Flogo.png&owner=1&pattern=Floating%20Cogs&stargazers=1&theme=Dark)
`underscore` is a `Go` library providing useful functional programming helpers without extending any built-in objects.
`underscore` is a `Go` library providing useful functional programming helpers without
extending any built-in objects.
It is mostly a port from the `underscore.js` library based on generics brought by `Go 1.18`.
It is mostly a port from the `underscore.js` library based on generics brought by
`Go 1.18`.
## Usage
@ -27,31 +29,32 @@ Please check out the [examples](examples) to see how to use the library.
package main
import (
"fmt"
u "github.com/rjNemo/underscore"
"fmt"
u "github.com/rjNemo/underscore"
)
func main() {
numbers := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
// filter even numbers from the slice
evens := u.Filter(numbers, func(n int) bool { return n%2 == 0 })
// square every number in the slice
squares := u.Map(evens, func(n int) int { return n * n })
// reduce to the sum
res := u.Reduce(squares, func(n, acc int) int { return n + acc }, 0)
numbers := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}
// filter even numbers from the slice
evens := u.Filter(numbers, func(n int) bool { return n%2 == 0 })
// square every number in the slice
squares := u.Map(evens, func(n int) int { return n * n })
// reduce to the sum
res := u.Reduce(squares, func(n, acc int) int { return n + acc }, 0)
fmt.Println(res) // 120
fmt.Println(res) // 120
}
```
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing
purposes.
These instructions will get you a copy of the project up and running on your local
machine for development and testing purposes.
### Prerequisites
You need at least `go1.18` for development. The project is shipped with a [Dockerfile](Dockerfile) based on `go1.18`.
You need at least `go1.18` for development. The project is shipped with a [Dockerfile](Dockerfile)
based on `go1.18`.
If you prefer local development, navigate to the [official
download page](https://go.dev/dl/) and install version `1.18` or beyond.
@ -92,6 +95,7 @@ make test
- `Each`
- `Filter`
- `Flatmap`
- `GroupBy`
- `Find`
- `Map`
- `Max`
@ -101,10 +105,11 @@ make test
### Pipe
Calling `NewPipe` will cause all future method calls to return wrapped values. When you've finished the computation,
call `Value` to retrieve the final value.
Calling `NewPipe` will cause all future method calls to return wrapped values. When
you've finished the computation, call `Value` to retrieve the final value.
Methods not returning a slice such as `Reduce`, `All`, `Any`, will break the `Chain` and return `Value` instantly.
Methods not returning a slice such as `Reduce`, `All`, `Any`, will break the `Chain`
and return `Value` instantly.
## Built With
@ -112,8 +117,8 @@ Methods not returning a slice such as `Reduce`, `All`, `Any`, will break the `Ch
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull
requests to us.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct,
and the process for submitting pull requests to us.
## Versioning
@ -124,13 +129,15 @@ the [tags on this repository](https://github.com/rjNemo/underscore/tags).
- **Ruidy** - _Initial work_ - [Ruidy](https://github.com/rjNemo)
See also the list of [contributors](https://github.com/rjNemo/underscore/contributors) who participated in this project.
See also the list of [contributors](https://github.com/rjNemo/underscore/contributors)
who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md)
file for details
## Acknowledgments
This project is largely inspired by [Underscore.js](https://underscorejs.org/#) library. Check out the original project
if you don't already know it.
This project is largely inspired by [Underscore.js](https://underscorejs.org/#)
library. Check out the original project if you don't already know it.