Skip to content

docs: update description in object/deep-set #9735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 3 commits into from
Jan 16, 2026
Merged

docs: update description in object/deep-set #9735

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6f1bd7
chore: fix package name
Neerajpathak07 Jan 14, 2026
c2dcf73
docs: address lint failure
kgryte Jan 16, 2026
19a7df5
docs: fix doctest failure
kgryte Jan 16, 2026
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
19 changes: 10 additions & 9 deletions lib/node_modules/@stdlib/object/deep-set/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,21 @@

Examples
--------
> var obj = { 'a': { 'b': { 'c': 'd' } } };
> var bool = {{alias}}( obj, 'a.b.c', 'beep' )
> var obj1 = { 'a': { 'b': { 'c': 'd' } } };
> var bool = {{alias}}( obj1, 'a.b.c', 'beep' )
true

// Specify an alternative separator via the sep option:
> obj = { 'a': { 'b': { 'c': 'd' } } };
> bool = {{alias}}( obj, 'a/b/c', 'beep', { 'sep': '/' } );
> obj
> var obj2 = { 'a': { 'b': { 'c': 'd' } } };
> bool = {{alias}}( obj2, 'a/b/c', 'beep', { 'sep': '/' } );
> obj2
{ 'a': { 'b': { 'c': 'beep' } } }

// To create a key path which does not exist, set the create option to true:
> bool = {{alias}}( obj, 'a.e.c', 'boop', { 'create': true } );
> obj
{ 'a': { 'b': { 'c': 'beep' }, 'e': { 'c': 'boop' } } }
> var obj3 = { 'a': { 'b': { 'c': 'd' } } };
> bool = {{alias}}( obj3, 'a.e.c', 'boop', { 'create': true } );
> obj3
{ 'a': { 'b': { 'c': 'd' }, 'e': { 'c': 'boop' } } }


{{alias}}.factory( path[, options] )
Expand All @@ -67,7 +68,7 @@
Returns
-------
out: Function
Deep get function.
Deep set function.

Examples
--------
Expand Down