set-utils

    1.0.4 • Public • Published

    set-utils

    Utility methods for working with Sets

    Installation

    $ npm install --save set-utils
    

    Methods

    toArrayArray

    Converts a Set to an Array

    map(set, cb)Set

    The map() method creates a new Set with the results of calling a provided function on every element in this Set

    filter(set, cb)Set

    The filter() method creates a new Set with all elements that pass the test implemented by the provided function

    union(set1, ...setN)Set

    The union() method returns a new Set comprised of the Sets provided as arguments.

    intersect(set1, set2, ...setN)Set

    Creates a Set of unique values that are included in all given sets.

    diff(set1, set2, ...setN)Set

    Creates a Set of values not included in the other given sets.

    join(set, separator)String

    The join() method joins all elements of a Set into a string.

    stringifyReplacer()

    A replacer function for use with JSON.stringify. Converts Set to an Array in JSON.

    toArray ⇒ Array

    Converts a Set to an Array

    Returns: Array - The converted Set

    Param Type Description
    set Set The Sets that should be converted to an Array

    map(set, cb) ⇒ Set

    The map() method creates a new Set with the results of calling a provided function on every element in this Set

    Returns: Set - The Set after mapping operation has been perfomed

    Param Type Description
    set Set The set you want to perform the mapping operation on
    cb function https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/map

    filter(set, cb) ⇒ Set

    The filter() method creates a new Set with all elements that pass the test implemented by the provided function

    Returns: Set - The resulting Set after the filter operation

    Param Type Description
    set Set The Set you want to filter
    cb function Function to test each element of the Set. Return true to keep the element, false otherwise

    union(set1, ...setN) ⇒ Set

    The union() method returns a new Set comprised of the Sets provided as arguments.

    Returns: Set - The new concatinated Set

    Param Type Description
    set1, ...setN Set The Sets you want to concatinate

    intersect(set1, set2, ...setN) ⇒ Set

    Creates a Set of unique values that are included in all given sets.

    Returns: Set - The intersection of the Sets given as arguments

    Param Type Description
    set1...SetN Set Two or more Sets you want to intersect.

    diff(set1, set2, ...setN) ⇒ Set

    Creates a Set of values not included in the other given sets.

    Returns: Set - The new Set of filtered values

    Param Type Description
    set1 Set The Set to inspect
    set2...setN Set The values to exclude

    join(set, separator) ⇒ String

    The join() method joins all elements of a Set into a string.

    Returns: String - A string result of every element in the Set

    Param Type Description
    set Set The Set you want to join
    separator String Optional. Specifies string you want to separate the elements of the Set

    stringifyReplacer()

    A replacer function for use with JSON.stringify. Converts Set to an Array in JSON.

    Install

    npm i set-utils

    DownloadsWeekly Downloads

    8

    Version

    1.0.4

    License

    MIT

    Unpacked Size

    9.83 kB

    Total Files

    4

    Last publish

    Collaborators

    • torbs