Skip to content

Commit e005dae

Browse files
committed
Update namespace
1 parent dbe2c8e commit e005dae

File tree

3 files changed

+18
-2
lines changed
  • lib/node_modules/@stdlib

3 files changed

+18
-2
lines changed

lib/node_modules/@stdlib/namespace/lib/namespace/d.js

+15-1
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,23 @@ ns.push({
8080
'value': require( '@stdlib/assert/deep-has-own-property' ),
8181
'type': 'Function',
8282
'related': [
83+
'@stdlib/assert/deep-has-property',
84+
'@stdlib/assert/has-own-property',
85+
'@stdlib/utils/deep-get',
86+
'@stdlib/utils/deep-pluck',
87+
'@stdlib/utils/deep-set'
88+
]
89+
});
90+
91+
ns.push({
92+
'alias': 'deepHasProp',
93+
'path': '@stdlib/assert/deep-has-property',
94+
'value': require( '@stdlib/assert/deep-has-property' ),
95+
'type': 'Function',
96+
'related': [
97+
'@stdlib/assert/deep-has-own-property',
8398
'@stdlib/assert/has-own-property',
8499
'@stdlib/utils/deep-get',
85-
'@stdlib/utils/deep-has-property',
86100
'@stdlib/utils/deep-pluck',
87101
'@stdlib/utils/deep-set'
88102
]

lib/node_modules/@stdlib/repl/code-blocks/lib/db.js

+1
Original file line numberDiff line numberDiff line change
@@ -703,6 +703,7 @@ module.exports = {
703703
"daysInYear": "num = daysInYear()\nnum = daysInYear( 2016 )\nnum = daysInYear( 2017 )\n",
704704
"deepGet": "obj = { 'a': { 'b': { 'c': 'd' } } };\nval = deepGet( obj, 'a.b.c' )\n\n// Specify a custom separator via the `sep` option:\nobj = { 'a': { 'b': { 'c': 'd' } } };\nval = deepGet( obj, 'a/b/c', { 'sep': '/' } )\n",
705705
"deepHasOwnProp": "obj = { 'a': { 'b': { 'c': 'd' } } };\nbool = deepHasOwnProp( obj, 'a.b.c' )\n\n// Specify a custom separator via the `sep` option:\nobj = { 'a': { 'b': { 'c': 'd' } } };\nbool = deepHasOwnProp( obj, 'a/b/c', { 'sep': '/' } )\n",
706+
"deepHasProp": "function Foo() { return this; };\nFoo.prototype.b = { 'c': 'd' };\nobj = { 'a': new Foo() };\nbool = deepHasProp( obj, 'a.b.c' )\n\n// Specify a custom separator via the `sep` option:\nbool = deepHasProp( obj, 'a/b/c', { 'sep': '/' } )\n",
706707
"deepPluck": "arr = [\n { 'a': { 'b': { 'c': 1 } } },\n { 'a': { 'b': { 'c': 2 } } }\n];\nout = deepPluck( arr, 'a.b.c' )\narr = [\n { 'a': [ 0, 1, 2 ] },\n { 'a': [ 3, 4, 5 ] }\n];\nout = deepPluck( arr, [ 'a', 1 ] )\n",
707708
"deepSet": "obj = { 'a': { 'b': { 'c': 'd' } } };\nbool = deepSet( obj, 'a.b.c', 'beep' )\n\n// Specify an alternative separator via the sep option:\nobj = { 'a': { 'b': { 'c': 'd' } } };\nbool = deepSet( obj, 'a/b/c', 'beep', { 'sep': '/' } );\nobj\n\n// To create a key path which does not exist, set the create option to true:\nbool = deepSet( obj, 'a.e.c', 'boop', { 'create': true } );\nobj\n",
708709
"dirname": "dir = dirname( './foo/bar/index.js' )\n",

lib/node_modules/@stdlib/repl/help/lib/db.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -702,7 +702,8 @@ module.exports = {
702702
"daysInMonth": "\ndaysInMonth( [month[, year]] )\n Returns the number of days in a month.\n\n By default, the function returns the number of days in the current month\n of the current year (according to local time). To determine the number of\n days for a particular month and year, provide `month` and `year` arguments.\n\n A `month` may be either a month's integer value, three letter abbreviation,\n or full name (case insensitive).\n\n The function also accepts a `Date` object.\n\n Parameters\n ----------\n month: string|integer|Date (optional)\n Month (or `Date`).\n\n year: integer (optional)\n Year.\n\n Returns\n -------\n out: integer\n Days in a month.\n\n Examples\n --------\n > var num = daysInMonth()\n <number>\n > num = daysInMonth( 2 )\n <number>\n > num = daysInMonth( 2, 2016 )\n 29\n > num = daysInMonth( 2, 2017 )\n 28\n\n // Other ways to supply month:\n > num = daysInMonth( 'feb', 2016 )\n 29\n > num = daysInMonth( 'february', 2016 )\n 29\n\n See Also\n --------\n daysInYear\n",
703703
"daysInYear": "\ndaysInYear( [value] )\n Returns the number of days in a year according to the Gregorian calendar.\n\n By default, the function returns the number of days in the current year\n (according to local time). To determine the number of days for a particular\n year, provide either a year or a `Date` object.\n\n Parameters\n ----------\n value: integer|Date (optional)\n Year or `Date` object.\n\n Returns\n -------\n out: integer\n Number of days in a year.\n\n Examples\n --------\n > var num = daysInYear()\n <number>\n > num = daysInYear( 2016 )\n 366\n > num = daysInYear( 2017 )\n 365\n\n See Also\n --------\n daysInMonth\n",
704704
"deepGet": "\ndeepGet( obj, path[, options] )\n Returns a nested property value.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: any\n Nested property value.\n\n Examples\n --------\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var val = deepGet( obj, 'a.b.c' )\n 'd'\n\n // Specify a custom separator via the `sep` option:\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var val = deepGet( obj, 'a/b/c', { 'sep': '/' } )\n 'd'\n\ndeepGet.factory( path[, options] )\n Creates a reusable deep get function.\n\n Parameters\n ----------\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: Function\n Deep get factory.\n\n Examples\n --------\n > var dget = deepGet.factory( 'a/b/c', { 'sep': '/' } );\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var val = dget( obj )\n 'd'\n\n See Also\n --------\n deepPluck, deepSet\n",
705-
"deepHasOwnProp": "\ndeepHasOwnProp( obj, path[, options] )\n Returns a boolean indicating whether an object contains a nested key path.\n\n If not provided an object, the function always returns `false`.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an object has a specified path.\n\n Examples\n --------\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var bool = deepHasOwnProp( obj, 'a.b.c' )\n true\n\n // Specify a custom separator via the `sep` option:\n > obj = { 'a': { 'b': { 'c': 'd' } } };\n > bool = deepHasOwnProp( obj, 'a/b/c', { 'sep': '/' } )\n true\n\ndeepHasOwnProp.factory( path[, options] )\n Returns a function which tests whether an object contains a nested key path.\n\n Parameters\n ----------\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: Function\n Function which tests whether an object contains a nested key path.\n\n Examples\n --------\n > var has = deepHasOwnProp.factory( 'a/b/c', { 'sep': '/' } );\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var bool = has( obj )\n true\n\n See Also\n --------\n hasOwnProp, deepGet, deepPluck, deepSet\n",
705+
"deepHasOwnProp": "\ndeepHasOwnProp( value, path[, options] )\n Returns a boolean indicating whether an object contains a nested key path.\n\n The function tests for \"own\" properties and will return `false` for\n inherited properties.\n\n Value arguments other than `null` or `undefined` are coerced to objects.\n\n Key path array elements are coerced to strings.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an object has a specified path.\n\n Examples\n --------\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var bool = deepHasOwnProp( obj, 'a.b.c' )\n true\n\n // Specify a custom separator via the `sep` option:\n > obj = { 'a': { 'b': { 'c': 'd' } } };\n > bool = deepHasOwnProp( obj, 'a/b/c', { 'sep': '/' } )\n true\n\ndeepHasOwnProp.factory( path[, options] )\n Returns a function which tests whether an object contains a nested key path.\n\n The returned function tests for \"own\" properties and will return `false` for\n inherited properties.\n\n Parameters\n ----------\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: Function\n Function which tests whether an object contains a nested key path.\n\n Examples\n --------\n > var has = deepHasOwnProp.factory( 'a/b/c', { 'sep': '/' } );\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var bool = has( obj )\n true\n\n See Also\n --------\n deepHasProp, hasOwnProp, deepGet, deepPluck, deepSet\n",
706+
"deepHasProp": "\ndeepHasProp( value, path[, options] )\n Returns a boolean indicating whether an object contains a nested key path,\n either own or inherited.\n\n Value arguments other than `null` or `undefined` are coerced to objects.\n\n Key path array elements are coerced to strings.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an object has a specified path.\n\n Examples\n --------\n > function Foo() { return this; };\n > Foo.prototype.b = { 'c': 'd' };\n > var obj = { 'a': new Foo() };\n > var bool = deepHasProp( obj, 'a.b.c' )\n true\n\n // Specify a custom separator via the `sep` option:\n > bool = deepHasProp( obj, 'a/b/c', { 'sep': '/' } )\n true\n\ndeepHasProp.factory( path[, options] )\n Returns a function which tests whether an object contains a nested key path,\n either own or inherited.\n\n Parameters\n ----------\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: Function\n Function which tests whether an object contains a nested key path.\n\n Examples\n --------\n > function Foo() { return this; };\n > Foo.prototype.b = { 'c': 'd' };\n > var has = deepHasProp.factory( 'a/b/c', { 'sep': '/' } );\n > var obj = { 'a': new Foo() };\n > var bool = has( obj )\n true\n\n See Also\n --------\n deepHasOwnProp, hasOwnProp, deepGet, deepPluck, deepSet\n",
706707
"deepPluck": "\ndeepPluck( arr, path[, options] )\n Extracts a nested property value from each element of an object array.\n\n If a key path does not exist, the function sets the plucked value as\n `undefined`.\n\n Extracted values are not cloned.\n\n Parameters\n ----------\n arr: Array\n Source array.\n\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.copy: boolean (optional)\n Boolean indicating whether to return a new data structure. Default:\n true.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: Array\n Destination array.\n\n Examples\n --------\n > var arr = [\n ... { 'a': { 'b': { 'c': 1 } } },\n ... { 'a': { 'b': { 'c': 2 } } }\n ... ];\n > var out = deepPluck( arr, 'a.b.c' )\n [ 1, 2 ]\n > arr = [\n ... { 'a': [ 0, 1, 2 ] },\n ... { 'a': [ 3, 4, 5 ] }\n ... ];\n > out = deepPluck( arr, [ 'a', 1 ] )\n [ 1, 4 ]\n\n See Also\n --------\n deepGet, deepSet\n",
707708
"deepSet": "\ndeepSet( obj, path[, options] )\n Sets a nested property value.\n\n Parameters\n ----------\n obj: ObjectLike\n Input object.\n\n path: string|Array\n Key path.\n\n value: any\n Value to set.\n\n options: Object (optional)\n Options.\n\n options.create: boolean (optional)\n Boolean indicating whether to create a path if the key path does not\n already exist. Default: false.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if the property was successfully set.\n\n Examples\n --------\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var bool = deepSet( obj, 'a.b.c', 'beep' )\n true\n\n // Specify an alternative separator via the sep option:\n > obj = { 'a': { 'b': { 'c': 'd' } } };\n > bool = deepSet( obj, 'a/b/c', 'beep', { 'sep': '/' } );\n > obj\n { 'a': { 'b': { 'c': 'beep' } } }\n\n // To create a key path which does not exist, set the create option to true:\n > bool = deepSet( obj, 'a.e.c', 'boop', { 'create': true } );\n > obj\n { 'a': { 'b': { 'c': 'beep' }, 'e': { 'c': 'boop' } } }\n\n\ndeepSet.factory( path[, options] )\n Creates a reusable deep set function.\n\n Parameters\n ----------\n path: string|Array\n Key path.\n\n options: Object (optional)\n Options.\n\n options.create: boolean (optional)\n Boolean indicating whether to create a path if the key path does not\n already exist. Default: false.\n\n options.sep: string (optional)\n Key path separator. Default: '.'.\n\n Returns\n -------\n out: Function\n Deep get function.\n\n Examples\n --------\n > var dset = deepSet.factory( 'a/b/c', {\n ... 'create': true,\n ... 'sep': '/'\n ... });\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var bool = dset( obj, 'beep' )\n true\n > obj\n { 'a': { 'b': { 'c': 'beep' } } }\n\n See Also\n --------\n deepGet, deepPluck\n",
708709
"dirname": "\ndirname( path )\n Returns a directory name.\n\n Parameters\n ----------\n path: string\n Path.\n\n Returns\n -------\n out: string\n Directory name.\n\n Examples\n --------\n > var dir = dirname( './foo/bar/index.js' )\n './foo/bar'\n\n See Also\n --------\n extname\n",

0 commit comments

Comments
 (0)