dictionary.ts
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

Dictionary.ts

travis npm downloads docs

Library provides APIs to work with mutable dictionaries, where dictionary is:

type Dict <a> = {[key:string]: a}

Library assumeth that passed dictionaries do not have a prototype chain to be concerned with, so either construct them with provided APIs or via Object.create(null), otherwise you may run into issues with inherited properties like toString and what not.

Warning on mutability

Library intentionally provides functional interface where it takes in dictionary & other params and returns a dictionary. But be aware that it actually mutates given dictionary in place and returns it back.

Recomended use as can be seen in [documentation examples][docs url] is to always use returned dictionary as if it was different from passed in dictionary while at the same time avoid touching a passed dictionary ever again. That would allow you to switch between mutable & (upcoming) immutable version of this library without breaking your code. Maybe I just really wish typescript had a [owneship system][] :)

Install

yarn

yarn add --save dictionary.ts

npm

npm install --save dictionary.ts

Prior Art

API of this library mostly follows the API of the Dict module from Elm core library.

Package Sidebar

Install

npm i dictionary.ts

Weekly Downloads

12

Version

0.1.0

License

MIT

Last publish

Collaborators

  • gozala