Function 'pick' returns is documented to always return a value. #14320

aredfox · 2017-01-28T19:12:08Z

See issue dot-object pick should return any in stead of void (sent PR) #14319

Function 'pick' returns is documented to always return a value. Before it's return type was :void, I'm sending this proposal as :any would fix this issue.
Reference to dot-object documentation: https://github.com/rhalff/dot-object#pickremove-a-value-using-dot-notation

Please fill in this template.

Make your PR against the master branch.
Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Follow the advice from the readme.
Avoid common mistakes.
Run tsc without errors.
Run npm run lint package-name if a tslint.json is present.

Select one of these and delete the others:

If adding a new definition:

The package does not provide its own types, and you can not add them.
If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package.
Create it with npm run new-package package-name, not by basing it on an existing project.
tslint.json should be present, and tsconfig.json should have noImplicitAny, noImplicitThis, and strictNullChecks set to true.

If changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes: <>
Increase the version number in the header if appropriate.
If you are making substantial changes, consider adding a tslint.json containing { "extends": "../tslint.json" }.

If removing a declaration:

If a package was never on DefinitelyTyped, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
Delete the package's directory.
Add it to notNeededPackages.json.

- See issue DefinitelyTyped#14319 Function 'pick' returns is documented to always return a value. Before it's return type was :void, I'm sending this proposal as :any would fix this issue. Reference to dot-object documentation: https://github.com/rhalff/dot-object#pickremove-a-value-using-dot-notation

dt-bot · 2017-01-28T19:12:10Z

dot-object/index.d.ts

to author (@nkovacic). Could you review this PR?
👍 or 👎?

Checklist

pass the Travis CI test?

aredfox · 2017-01-28T19:16:10Z

URL to documentation & info: #14319

aredfox · 2017-01-28T19:16:59Z

cc @rhalff - author of dot-object - for his advice/input

aredfox · 2017-01-28T19:19:59Z

dot-object/index.d.ts

@@ -109,7 +109,7 @@ declare namespace DotObject {
         * @param {Object} obj
         * @param {Boolean} remove
         */
-        pick(path: string, obj: any, remove?: boolean): void;
+        pick(path: string, obj: any, remove?: boolean): any;


tested this in my production code, and TypeScript was now happy.

did this according to my experience with using the function and the documentation as described in https://github.com/rhalff/dot-object#pickremove-a-value-using-dot-notation

The return type is definitely any.

thanks for the quick feedback @rhalff

Bumped version number as asked in checklist

aredfox · 2017-01-28T19:21:22Z

dot-object/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Dot-Object v1.4.2
+// Type definitions for Dot-Object v1.4.3


Bumped the version number, as asked in the checklist/guidelines

We only use MAJOR.MINOR for version numbers. Can you strip the last portion off?

Ok, will make it 1.5 then I guess?

DanielRosenwasser · 2017-01-29T05:15:12Z

dot-object/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Dot-Object v1.4.2
+// Type definitions for Dot-Object v1.4.3


We only use MAJOR.MINOR for version numbers. Can you strip the last portion off?

To comply with maj.min versioning ref comment DefinitelyTyped#14320 (comment)

aredfox · 2017-01-29T08:29:48Z

dot-object/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Dot-Object v1.4.2
+// Type definitions for Dot-Object v1.5


@DanielRosenwasser bumped it now straight to v1.5
thanks

aredfox · 2017-01-29T22:19:41Z

is there a way I can work around this in typescript "typings" of "tsconfig.json" (in stead of editing the index.d.ts file every time I do an npm i on any machines where I and my fellow people work on) - until @DanielRosenwasser or @nkovacic reviewed and/or accepted this?

as I'm fairly new to typescript and I don't see an option to point it temporarily to a git repo/fork? Stupid question maybe?

- added info on workaround for current @types/dot-object pick method (see PR: DefinitelyTyped/DefinitelyTyped#14320)

nkovacic · 2017-01-30T07:54:00Z

👍 Looks good

aredfox · 2017-02-01T02:49:44Z

A polite ping/bump to @DanielRosenwasser and @nkovacic to futher review/merge the PR when appropriate?

DanielRosenwasser · 2017-02-01T08:17:25Z

Thanks! Sorry for the delay!

To answer your question: right now you can take the .d.ts file and add it to a folder in your project. Then use path mappings (i.e. the paths field in your tsconfig.json) so that whenever someone imports a path like "foo", it always points to the appropriate .d.ts file

There's an extremely technical document about path mappings here: microsoft/TypeScript#5039

aredfox · 2017-02-02T07:37:11Z

Thanks @DanielRosenwasser - no prob on the delay, I know we all have a job (or multiple) and this is all voluntary work. Thanks for introducting me to the path mappings as well!

To comply with maj.min versioning ref comment DefinitelyTyped#14320 (comment)

aredfox mentioned this pull request Jan 28, 2017

dot-object pick should return any in stead of void (sent PR) #14319

Closed

2 tasks

aredfox commented Jan 28, 2017

View reviewed changes

Bumped version number

4262c39

Bumped version number as asked in checklist

aredfox commented Jan 28, 2017

View reviewed changes

DanielRosenwasser requested changes Jan 29, 2017

View reviewed changes

Changed versioning to MAJOR.MINOR

8afb9e8

To comply with maj.min versioning ref comment DefinitelyTyped#14320 (comment)

aredfox commented Jan 29, 2017

View reviewed changes

aredfox added a commit to aredfox/electron-starter that referenced this pull request Jan 29, 2017

- tested on macOS, linux (debian), win7 and 10

7a5ac85

- added info on workaround for current @types/dot-object pick method (see PR: DefinitelyTyped/DefinitelyTyped#14320)

DanielRosenwasser merged commit dba28e9 into DefinitelyTyped:master Feb 1, 2017

aredfox deleted the patch-1 branch February 2, 2017 07:37

annich-MS pushed a commit to annich-MS/DefinitelyTyped that referenced this pull request Feb 21, 2017

Changed versioning to MAJOR.MINOR

d5d0bf1

To comply with maj.min versioning ref comment DefinitelyTyped#14320 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Function 'pick' returns is documented to always return a value. #14320

Function 'pick' returns is documented to always return a value. #14320

aredfox commented Jan 28, 2017 •

edited

Loading

dt-bot commented Jan 28, 2017

aredfox commented Jan 28, 2017

aredfox commented Jan 28, 2017 •

edited

Loading

aredfox Jan 28, 2017

rhalff Jan 28, 2017

aredfox Jan 28, 2017

aredfox Jan 28, 2017

DanielRosenwasser Jan 29, 2017

aredfox Jan 29, 2017

DanielRosenwasser Jan 29, 2017

aredfox Jan 29, 2017

aredfox commented Jan 29, 2017 •

edited

Loading

nkovacic commented Jan 30, 2017

aredfox commented Feb 1, 2017 •

edited

Loading

DanielRosenwasser commented Feb 1, 2017

aredfox commented Feb 2, 2017

		@@ -1,4 +1,4 @@
		// Type definitions for Dot-Object v1.4.2
		// Type definitions for Dot-Object v1.4.3

		@@ -1,4 +1,4 @@
		// Type definitions for Dot-Object v1.4.2
		// Type definitions for Dot-Object v1.5

Function 'pick' returns is documented to always return a value. #14320

Function 'pick' returns is documented to always return a value. #14320

Conversation

aredfox commented Jan 28, 2017 • edited Loading

dt-bot commented Jan 28, 2017

aredfox commented Jan 28, 2017

aredfox commented Jan 28, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aredfox commented Jan 29, 2017 • edited Loading

nkovacic commented Jan 30, 2017

aredfox commented Feb 1, 2017 • edited Loading

DanielRosenwasser commented Feb 1, 2017

aredfox commented Feb 2, 2017

aredfox commented Jan 28, 2017 •

edited

Loading

aredfox commented Jan 28, 2017 •

edited

Loading

aredfox commented Jan 29, 2017 •

edited

Loading

aredfox commented Feb 1, 2017 •

edited

Loading