Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -4306,7 +4306,7 @@ objectEntries,"\nobjectEntries( obj )\n Returns an array of an object's own e
objectEntriesIn,"\nobjectEntriesIn( obj )\n Returns an array of an object's own and inherited enumerable property\n `[key, value]` pairs.\n\n Entry order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic return values.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n Returns\n -------\n arr: Array\n Array containing key-value pairs.\n\n Examples\n --------\n > function Foo() { this.beep = 'boop'; return this; };\n > Foo.prototype.foo = 'bar';\n > var obj = new Foo();\n > var entries = objectEntriesIn( obj )\n e.g., [ [ 'beep', 'boop' ], [ 'foo', 'bar' ] ]\n\n See Also\n --------\n objectEntries, objectFromEntries, keysIn, objectValuesIn\n"
objectFromEntries,"\nobjectFromEntries( entries )\n Creates an object from an array of key-value pairs.\n\n Parameters\n ----------\n entries: Array<Array>\n Input object.\n\n Returns\n -------\n out: Object\n Object created from `[key, value]` pairs.\n\n Examples\n --------\n > var entries = [ [ 'beep', 'boop' ], [ 'foo', 'bar' ] ];\n > var obj = objectFromEntries( entries )\n { 'beep': 'boop', 'foo': 'bar' }\n\n See Also\n --------\n objectEntries\n"
objectInverse,"\nobjectInverse( obj[, options] )\n Inverts an object, such that keys become values and values become keys.\n\n Beware when providing objects having values which are themselves objects.\n The function relies on native object serialization (`#toString`) when\n converting values to keys.\n\n Insertion order is not guaranteed, as object key enumeration is not\n specified according to the ECMAScript specification. In practice, however,\n most engines use insertion order to sort an object's keys, thus allowing for\n deterministic inversion.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n options: Object (optional)\n Options.\n\n options.duplicates: boolean (optional)\n Boolean indicating whether to store keys mapped to duplicate values in\n arrays. Default: `true`.\n\n Returns\n -------\n out: Object\n Inverted object.\n\n Examples\n --------\n // Basic usage:\n > var obj = { 'a': 'beep', 'b': 'boop' };\n > var out = objectInverse( obj )\n { 'beep': 'a', 'boop': 'b' }\n\n // Duplicate values:\n > obj = { 'a': 'beep', 'b': 'beep' };\n > out = objectInverse( obj )\n { 'beep': [ 'a', 'b' ] }\n\n // Override duplicate values:\n > obj = {};\n > obj.a = 'beep';\n > obj.b = 'boop';\n > obj.c = 'beep';\n > out = objectInverse( obj, { 'duplicates': false } )\n { 'beep': 'c', 'boop': 'b' }\n\n See Also\n --------\n objectInverseBy\n"
objectInverseBy,"\nobjectInverseBy( obj, [options,] transform )\n Inverts an object, such that keys become values and values become keys,\n according to a transform function.\n\n The transform function is provided three arguments:\n\n - key: object key.\n - value: object value corresponding to `key`.\n - obj: the input object.\n\n The value returned by a transform function should be a value which can be\n serialized as an object key. Hence, beware when providing objects having\n values which are themselves objects. The function relies on native object\n serialization (`#toString`) when converting transform function return values\n to keys.\n\n Insertion order is not guaranteed, as object key enumeration is not\n specified according to the ECMAScript specification. In practice, however,\n most engines use insertion order to sort an object's keys, thus allowing for\n deterministic inversion.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n options: Object (optional)\n Options.\n\n options.duplicates: boolean (optional)\n Boolean indicating whether to store keys mapped to duplicate values in\n arrays. Default: `true`.\n\n transform: Function\n Transform function.\n\n Returns\n -------\n out: Object\n Inverted object.\n\n Examples\n --------\n // Basic usage:\n > function transform( key, value ) { return key + value; };\n > var obj = { 'a': 'beep', 'b': 'boop' };\n > var out = objectInverseBy( obj, transform )\n { 'abeep': 'a', 'bboop': 'b' }\n\n // Duplicate values:\n > function transform( key, value ) { return value; };\n > obj = { 'a': 'beep', 'b': 'beep' };\n > out = objectInverseBy( obj, transform )\n { 'beep': [ 'a', 'b' ] }\n\n // Override duplicate values:\n > obj = {};\n > obj.a = 'beep';\n > obj.b = 'boop';\n > obj.c = 'beep';\n > out = objectInverseBy( obj, { 'duplicates': false }, transform )\n { 'beep': 'c', 'boop': 'b' }\n\n See Also\n --------\n objectInverse\n"
objectInverseBy,"\nobjectInverseBy( obj, [options,] transform )\n Inverts an object, such that keys become values and values become keys,\n according to a transform function.\n\n The transform function is provided three arguments:\n\n - key: object key.\n - value: object value corresponding to `key`.\n - obj: the input object.\n\n The value returned by a transform function should be a value which can be\n serialized as an object key. Hence, beware when providing objects having\n values which are themselves objects. The function relies on native object\n serialization (`#toString`) when converting transform function return values\n to keys.\n\n In older JavaScript engines, insertion order is not guaranteed, as object\n key enumeration was not specified according to the ECMAScript specification\n in earlier editions. In practice, however, most older engines use insertion\n order to sort an object's keys, thus allowing for deterministic inversion.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n options: Object (optional)\n Options.\n\n options.duplicates: boolean (optional)\n Boolean indicating whether to store keys mapped to duplicate values in\n arrays. Default: `true`.\n\n transform: Function\n Transform function.\n\n Returns\n -------\n out: Object\n Inverted object.\n\n Examples\n --------\n // Basic usage:\n > function transform( key, value ) { return key + value; };\n > var obj = { 'a': 'beep', 'b': 'boop' };\n > var out = objectInverseBy( obj, transform )\n { 'abeep': 'a', 'bboop': 'b' }\n\n // Duplicate values:\n > function transform( key, value ) { return value; };\n > obj = { 'a': 'beep', 'b': 'beep' };\n > out = objectInverseBy( obj, transform )\n { 'beep': [ 'a', 'b' ] }\n\n // Override duplicate values:\n > obj = {};\n > obj.a = 'beep';\n > obj.b = 'boop';\n > obj.c = 'beep';\n > out = objectInverseBy( obj, { 'duplicates': false }, transform )\n { 'beep': 'c', 'boop': 'b' }\n\n See Also\n --------\n objectInverse\n"
objectKeys,"\nobjectKeys( value )\n Returns an array of an object's own enumerable property names.\n\n Name order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic extraction.\n\n If provided `null` or `undefined`, the function returns an empty array.\n\n Parameters\n ----------\n value: any\n Input value.\n\n Returns\n -------\n keys: Array\n List of an object's own enumerable property names.\n\n Examples\n --------\n > function Foo() { this.beep = 'boop'; return this; };\n > Foo.prototype.foo = 'bar';\n > var obj = new Foo();\n > var keys = objectKeys( obj )\n [ 'beep' ]\n\n See Also\n --------\n objectEntries, keysIn, nonIndexKeys, objectValues\n"
objectValues,"\nobjectValues( obj )\n Returns an array of an object's own enumerable property values.\n\n Value order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic extraction.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n Returns\n -------\n values: Array\n Value array.\n\n Examples\n --------\n > var obj = { 'beep': 'boop', 'foo': 'bar' };\n > var vals = objectValues( obj )\n e.g., [ 'boop', 'bar' ]\n\n See Also\n --------\n objectEntries, objectKeys\n"
objectValuesIn,"\nobjectValuesIn( obj )\n Returns an array of an object's own and inherited enumerable property\n values.\n\n Value order is not guaranteed, as object key enumeration is not specified\n according to the ECMAScript specification. In practice, however, most\n engines use insertion order to sort an object's keys, thus allowing for\n deterministic extraction.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n Returns\n -------\n values: Array\n Value array.\n\n Examples\n --------\n > function Foo() { this.beep = 'boop'; return this; };\n > Foo.prototype.foo = 'bar';\n > var obj = new Foo();\n > var values = objectValuesIn( obj )\n e.g., [ 'boop', 'bar' ]\n\n See Also\n --------\n objectEntriesIn, keysIn, objectValues\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.