map-like
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    map-like Build Status

    ECMAScript Map like class.

    It has same API with Map - JavaScript | MDN.

    It is tiny library - 1.5kB(gzip).

    ✈ bundle-size map-like
    map-like@1.0.3
    
    env  bundle   minify   gzip
    --   5.73 kB  3.08 kB  1.5 kB
    

    Limitation ⚠️

    • Not support Symbol.Iterator - it means MapLike is not iterable.
    • Not support toString()

    Install

    Install with npm:

    npm install map-like
    

    Usage

    const { MapLike } = require("map-like");
    const map = new MapLike(["key", "value"]);
    const value = map.get("key");
    map.set("newKey", "newValue");

    API

    MapLike

    ES6 Map like object. See Map - JavaScript | MDN

    size

    return map size

    Returns: Number

    entries(): Array

    entries [[key, value], [key, value]] value

    Returns: Array

    keys(): Array

    get keys

    Returns: Array

    values(): Array

    get values

    Returns: Array

    get(key: Any): Any

    Parameters

    • key: Any - The key of the element to return from the Map object.

    Returns: Any

    has(key: Any): boolean

    has value of key

    Parameters

    • key: Any - The key of the element to return from the Map object.

    Returns: boolean

    set(key: Any, value: Any): MapLike

    set value for key

    Parameters

    • key: Any - The key of the element to return from the Map object.
    • value: Any

    Returns: MapLike

    delete(key: Any): boolean

    delete value for key

    Parameters

    • key: Any - The key of the element to return from the Map object.

    Returns: boolean

    clear(): MapLike

    clear defined key,value

    Returns: MapLike

    forEach(handler: function (value, key, map), thisArg: [Any])

    forEach map

    Parameters

    • handler: function (value, key, map)
    • thisArg: [Any]

    Changelog

    See Releases page.

    Running tests

    Install devDependencies and Run npm test:

    npm i -d && npm test
    

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    1. Fork it!
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    Author

    License

    MIT © azu

    Thanks

    Test MapLike with test-case of https://github.com/Financial-Times/polyfill-service/blob/master/polyfills/Map/tests.js.

    Install

    npm i map-like

    DownloadsWeekly Downloads

    15,118

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • azu