Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vicary/multidict
A TypeScript implementation of a key-value store that supports multiple keys and values.
https://github.com/vicary/multidict
array-map bidirectional-mapping dictionary graph many-to-many-relationship map multiple-keys multiple-values object-map two-way-association
Last synced: 28 days ago
JSON representation
A TypeScript implementation of a key-value store that supports multiple keys and values.
- Host: GitHub
- URL: https://github.com/vicary/multidict
- Owner: vicary
- License: mit
- Created: 2023-03-21T03:32:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T10:42:05.000Z (10 months ago)
- Last Synced: 2024-04-14T13:52:01.567Z (9 months ago)
- Topics: array-map, bidirectional-mapping, dictionary, graph, many-to-many-relationship, map, multiple-keys, multiple-values, object-map, two-way-association
- Language: TypeScript
- Homepage: https://npmjs.org/package/multidict
- Size: 17.7 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# MultiDict
MultiDict is an extension of Map that supports bidirectioal, many to many
relations amongst multiple keys and values.
## Usage
```ts
import { MultiDict } from "multidict";
const myMap = new MultiDict();
myMap.set("foo", 1);
myMap.set("foo", 2);
myMap.set(3, "bar"); // In a two-way reference model, key and value means the same thing.
console.log(myMap.get("foo")); // -> Set { 1, 2 }
console.log(myMap.get(1)); // -> Set { "foo" }
console.log(myMap.get("bar")); // -> Set { 3 }
console.log(myMap.get(3)); // -> Set { "bar" }
```
You may also use it like an iterator:
```ts
for (const [key, values] of myMap) {
for (const value of values) {
console.log(key, value);
}
}
```
MultiDict supports all of the standard Map methods, but always return a Set of
values.
You can easily deletes all values associated with a key with the `delete()`
method, or only deletes one specific key-value pair by specifying the value as
well:
```ts
myMap.set("foo", 1);
myMap.set(2, "foo");
myMap.set("foo", 3);
myMap.delete("foo", 1);
console.log(myMap.get("foo")); // -> Set { 2, 3 }
myMap.delete("foo");
console.log(myMap.get("foo")); // -> undefined
console.log(myMap.get(2)); // -> undefined
```
## API
1. `clear()`: Clears all key-value pairs from the store.
1. `delete(key: K, value?: V): boolean`: Deletes a key-value pair from the
store. If a value parameter is provided, only the specified key-value pair is
deleted. If no value parameter is provided, all key-value pairs associated
with the specified key are deleted. Returns true if the key-value pair(s)
were deleted, false otherwise.
1. `entries()`: Returns an iterator of all key-value pairs in the store.
1. `forEach(callbackfn: (value: Set, key: K | V, map: Map>) => void, thisArg?: any)`:
Calls a provided function once for each key-value pair in the store, in
insertion order.
1. `get(key: K): Set | undefined`: Returns a Set of all values associated
with the specified key, or undefined if the key is not present in the store.
1. `has(key: K | V): boolean`: Returns true if the specified key or value is
present in the store, false otherwise.
1. `keys()`: Returns an iterator of all keys in the store.
1. `set(key: K, value: V): this`: Associates a key with a value in the store.
Returns the same instance to allow for method chaining. If the key or value
already exists in the store, the existing values associated with the key or
value are preserved, and the new value is added to the existing set of
values.
1. `size`: Returns the number of key-value pairs in the store.
1. `values()`: Returns an iterator of all values in the store.
## Contributing
If you find a bug or would like to suggest a new feature, please open an issue
or submit a pull request on GitHub.
## License
MultiDict is licensed under the MIT License. See the LICENSE file for more
information.
## Funding
If you find this project useful, please consider supporting it by donating to
the author.
[](https://github.com/sponsors/vicary)