Skip to content

JoelLefkowitz/maps-eager

Repository files navigation

Maps eager

Eagerly evaluated functions for Maps.

Review Version Quality

Installing

spago install maps-eager

Documentation

Documentation and more detailed examples are hosted on Pursuit.

Usage

Given a Map:

map :: Map String Int
map = fromFoldable [ Tuple "a" 1 , Tuple "b" 2 , Tuple "c" 3]

Often we want to iterate over the keys and values. This package provides functions that return the keys and values in an Array.

> keys map
[ "a", "b", "c" ]

> values map
[ 1, 2, 3 ]

Also given a value you can search for matching keys:

reverseLookup 3
> Just "c"

reverseLookupAll 3
> ["c"]

Tooling

Dependencies

To install dependencies:

yarn install
yarn spago install

Tests

To run tests:

yarn spago test

Documentation

To generate the documentation locally:

yarn spago docs

Linters

To run linters:

yarn lint

Formatters

To run formatters:

yarn format

Contributing

Please read this repository's Code of Conduct which outlines our collaboration standards and the Changelog for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit SemVer.

Bump2version is used to version and tag changes. For example:

bump2version patch

Contributors

Remarks

Lots of love to the open source community!

Be kind to your mind Love each other It's ok to have a bad day