Skip to content

updated documentation #4

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

Open
eckhartcke wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updated documentation #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@ ptk.get(data, 'foo.b.indexOf(@".")'); // 3

### getWithDefault
```javascript
var val1 = ptk.get(obj, path, defaultReturnVal);
var val2 = ptk.get(obj, path, defaultReturnVal, arg1, arg2,..., argN);
var val1 = ptk.getWithDefault(obj, path, defaultReturnVal);
var val2 = ptk.getWithDefault(obj, path, defaultReturnVal, arg1, arg2,..., argN);
```

`getWithDefault` behaves exactly the same as `get`. When the resolved value is undefined, either because of an invalid path or because `undefined` is the value resolved by the path, the value in the `defaultReturnVal` argument will be returned in place of the current default return val configured for this path-toolkit instance.
Expand Down