https://github.com/kritzcreek/motoko-text-map

A Motoko hashmap that fixes the key type to Text
https://github.com/kritzcreek/motoko-text-map

Last synced: about 2 hours ago
JSON representation

A Motoko hashmap that fixes the key type to Text

• Host: GitHub
• URL: https://github.com/kritzcreek/motoko-text-map
• Owner: kritzcreek
• License: apache-2.0
• Created: 2021-04-02T17:15:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-04-11T10:38:28.000Z (over 3 years ago)
• Last Synced: 2024-10-11T23:54:53.690Z (26 days ago)
• Language: Modelica
• Homepage: https://kritzcreek.github.io/motoko-text-map
• Size: 30.3 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-motoko - motoko-text-map - A Motoko Hashmap that fixes its key type to Text. (Libraries / Data structures)

README

        
# motoko-text-map

A Motoko Hashmap that fixes its key type to Text.

People have reported that `base`'s HashMap type is less ergonomic than they'd like because they have to pass both an equality as well as a hash function on construction. So here's a monomorphic version of a HashMap with a few different implementation details.

## How to develop

- Write your library code in `*.mo` source files in the `src/` directory.

- Run `make check` to make sure your changes compile (or use the

  VSCode extension to get quicker feedback)

- Add tests to the source files in the `test/` directory, and run them

  with `make test`. The project template is set up to include

  motoko-matchers.

- Generate API documentation locally by running `make docs` and then

  open the resulting `docs/index.html` in your browser

## How to publish

- Create a git tag for the commit you'd like to be the published

  version. For example:

  ```bash

  git tag v1.1.0

  git push origin v1.1.0

  ```

- Follow the instructions at

  [`vessel-package-set`](https://github.com/dfinity/vessel-package-set)

  to make it easy for other to install your library

## API Documentation

API documentation for this library can be found at https://kritzcreek.github.io/motoko-text-map

## License

motoko-text-map is distributed under the terms of the Apache License (Version 2.0).

See LICENSE for details.