https://github.com/goswinr/dicts

F# Extensions and modules around Dictionary<'T>
https://github.com/goswinr/dicts

defaultdict dictionary fable fable-libraries fsharp library

Last synced: about 2 months ago
JSON representation

F# Extensions and modules around Dictionary<'T>

• Host: GitHub
• URL: https://github.com/goswinr/dicts
• Owner: goswinr
• License: mit
• Created: 2024-02-25T20:05:36.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-01T13:15:41.000Z (3 months ago)
• Last Synced: 2024-11-01T13:35:10.912Z (3 months ago)
• Topics: defaultdict, dictionary, fable, fable-libraries, fsharp, library
• Language: F#
• Homepage: https://goswinr.github.io/Dicts/
• Size: 289 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        

![Logo](https://raw.githubusercontent.com/goswinr/Dicts/main/Docs/img/logo128.png)

# Dicts

[![Dicts on nuget.org](https://img.shields.io/nuget/v/Dicts)](https://www.nuget.org/packages/Dicts/)

[![Build Status](https://github.com/goswinr/Dicts/actions/workflows/build.yml/badge.svg)](https://github.com/goswinr/Dicts/actions/workflows/build.yml)

[![Docs Build Status](https://github.com/goswinr/Dicts/actions/workflows/docs.yml/badge.svg)](https://github.com/goswinr/Dicts/actions/workflows/docs.yml)

[![Test Status](https://github.com/goswinr/Dicts/actions/workflows/test.yml/badge.svg)](https://github.com/goswinr/Dicts/actions/workflows/test.yml)

[![license](https://img.shields.io/github/license/goswinr/Dicts)](LICENSE.md)

![code size](https://img.shields.io/github/languages/code-size/goswinr/Dicts.svg)

This F# library provides:

- A dedicated `Dict<'T>` type. It is a thin wrapper around `Dictionary<'T>` with more functionality and nicer Error messages.

- A `DefaultDict<'T>` type. It works like [Python's' defaultdict](https://docs.python.org/3/library/collections.html#collections.defaultdict).


By providing a default function in the constructor it will always return a value for any key.

- Extension methods for working with the `IDictionary<'T>` interface.

It also works in JS and TS with [Fable](https://fable.io/).

This library was designed for use with F# scripting.

Functions and methods never return null.

Only functions starting with `try...` will return an F# Option.

Otherwise when a function fails on invalid input it will throw a descriptive exception.

I was always annoyed that a KeyNotFoundExceptions does not include the actual bad key nor a pretty printed dictionary.

This library fixes that in `iDictionary.Get`, `iDictionary.Set` and other item access functions.

### Example

```fsharp

#r "nuget: Dicts"

open Dicts

let dd = DefaultDict(fun _ -> ref 99)

incr dd.["A"]   // since dd.["A"] does not exist it will be created with the default value 99, and then incremented  to 100

incr dd.["A"]   // now it exists and will be incremented to 101

dd.["A"].Value  = 101 // true

```

### Full API Documentation

[goswinr.github.io/Dicts](https://goswinr.github.io/Dicts/reference/dicts.html)

### Tests

All Tests run in both javascript and dotnet.

Successful Fable compilation to typescript is verified too.

Go to the tests folder:

```bash

cd Tests

```

For testing with .NET using Expecto:

```bash

dotnet run

```

for JS testing with Fable.Mocha and TS verification:

```bash

npm test

```

### License

[MIT](https://raw.githubusercontent.com/goswinr/Dicts/main/LICENSE.txt)

### Changelog

see [CHANGELOG.md](https://github.com/goswinr/Dicts/blob/main/CHANGELOG.md)