Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joellefkowitz/maps-eager
Eagerly evaluated functions for Maps.
https://github.com/joellefkowitz/maps-eager
eager lookup maps reverse values
Last synced: 10 days ago
JSON representation
Eagerly evaluated functions for Maps.
- Host: GitHub
- URL: https://github.com/joellefkowitz/maps-eager
- Owner: JoelLefkowitz
- License: mit
- Created: 2021-05-30T21:37:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T18:56:09.000Z (6 months ago)
- Last Synced: 2024-10-05T21:41:40.317Z (3 months ago)
- Topics: eager, lookup, maps, reverse, values
- Language: PureScript
- Size: 482 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Maps eager
Eagerly evaluated functions for Maps.
## Installing
```bash
spago install maps-eager
```
## Documentation
Documentation and more detailed examples are hosted on [Pursuit](https://pursuit.purescript.org/packages/purescript-maps-eager).
## Usage
Given a `Map`:
```purs
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`.
```purs
> keys map
[ "a", "b", "c" ]
> values map
[ 1, 2, 3 ]
```
Also given a value you can search for matching keys:
```purs
reverseLookup 3
> Just "c"
reverseLookupAll 3
> ["c"]
```
## Tooling
### Dependencies
To install dependencies:
```bash
yarn install
yarn spago install
```
### Tests
To run tests:
```bash
yarn spago test
```
### Documentation
To generate the documentation locally:
```bash
yarn spago docs
```
### Linters
To run linters:
```bash
yarn lint
```
### Formatters
To run formatters:
```bash
yarn format
```
## Contributing
Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.
This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).
Bump2version is used to version and tag changes. For example:
```bash
bump2version patch
```
### Contributors
- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work
## Remarks
Lots of love to the open source community!
