underscore

Underscore

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 go1.18.

Usage

Install the library using

go get github.com/rjNemo/underscore

Please check out the examples to see how to use the library.

package main

import (
	"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)

	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.

Prerequisites

You need at least go1.18 for development. The project is shipped with a Dockerfile based on go1.18. If you prefer local development, at the moment the easiest way to do it:

go install golang.org/dl/go1.18beta1@latest
go1.18beta1 download

Installing

First clone the repository

git clone https://github.com/rjNemo/underscore.git

Install dependencies

go mod download

And that's it.

Tests

Building the docker image will run the tests automatically. Otherwise, you can simply run:

go test ./...

Functions

underscore provides 100s of functions that support your favorite functional helpers

Collections

• Contains (only numerics values at the moment)
• Each
• Every
• Filter
• Find
• Map
• Max
• Min
• Partition
• Reduce
• Some

Chaining

Calling NewChain will cause all future method calls to return wrapped objects. When you've finished the computation, call Value to retrieve the final value.

Methods not returning a slice such as Reduce, Every, Some, will break the chain and return Value instantly.

Built With

• Go - Build fast, reliable, and efficient software at scale

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ruidy - Initial work - Ruidy

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

This project is largely inspired by Underscore.js library. Check out the original project if you don't already know it.