Skip to content

Commit 285f4ed

Browse files
committed
Update descriptions
1 parent 0c35baa commit 285f4ed

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

lib/node_modules/@stdlib/utils/deep-get/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ interface Options {
3737
type Unary = ( obj: any ) => any;
3838

3939
/**
40-
* Interface for the deepGet function.
40+
* Interface for retrieving nested property values.
4141
*/
4242
interface DeepGet {
4343
/**
@@ -77,15 +77,15 @@ interface DeepGet {
7777
( obj: any, path: string | Array<string>, options?: Options ): any;
7878

7979
/**
80-
* Creates a reusable deep get factory.
80+
* Returns a function for retrieving a nested property value.
8181
*
8282
* @param path - key path
8383
* @param options - function options
8484
* @param options.sep - key path separator (default: '.')
8585
* @returns deep get factory
8686
*
8787
* @example
88-
* var dget = factory( 'a/b/c', {
88+
* var dget = deepGet.factory( 'a/b/c', {
8989
* 'sep': '/'
9090
* });
9191
*/

lib/node_modules/@stdlib/utils/deep-get/lib/factory.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ var dget = require( './dget.js' );
3232
// MAIN //
3333

3434
/**
35-
* Creates a reusable deep get factory.
35+
* Returns a function for retrieving a nested property value.
3636
*
3737
* @param {(string|Array)} path - key path
3838
* @param {Options} [options] - function options
3939
* @param {string} [options.sep='.'] - key path separator
4040
* @throws {TypeError} first argument must be a string primitive or key array
4141
* @throws {TypeError} options argument must be an object
4242
* @throws {TypeError} must provide valid options
43-
* @returns {Function} deep get factory
43+
* @returns {Function} deep get function
4444
*
4545
* @example
4646
* var dget = factory( 'a/b/c', {

0 commit comments

Comments
 (0)