Typescript definitions #646

mxl · 2017-10-05T15:43:06Z

Fixes #363

Roadmap:

wait for Add Calculator type to markerclustererplus. DefinitelyTyped/DefinitelyTyped#20322 to get merged
improve https://github.com/mahnunchik/markerclustererplus definitions in DefinitelyTyped repository (tslint and some optimizations), see markerclustererplus: lint, ClusterIcon, tests, fixes. DefinitelyTyped/DefinitelyTyped#20337
add definitions for https://github.com/lucasfs7/google-maps-infobox-module
finish react-google-maps definitions

tomchentw · 2017-10-06T02:52:11Z

types/index.d.ts

+
+    export function withGoogleMap<P>(wrappedComponent: string | ComponentClass<P> | StatelessComponent<P>): ComponentClass<P & WithGoogleMapProps>
+
+    export interface GoogleMapProps {


How do you generate these type definitions? By hand?

Could they be generate typed code from src/macro directly using jscodeshift API? That could save you lots of time.

I do not see any documentation on how to do this. I could possibly spend time and write definitions generator that uses jscodeshift API but it will take much more time than writing these definitions. Also I'm sure that it will still require some manual adjustments.

mxl · 2017-10-06T23:33:12Z

@tomchentw You can review definitions. The only thing left is to move InfoBox definitions to https://github.com/lucasfs7/google-maps-infobox-module or https://github.com/DefinitelyTyped/DefinitelyTyped.

tomchentw · 2017-10-17T08:35:36Z

Just had a quick review, it looks awesome! Thanks for the hard work!

@mxl : The only thing left is to move InfoBox definitions to https://github.com/lucasfs7/google-maps-infobox-module or https://github.com/DefinitelyTyped/DefinitelyTyped.

They both looks fine to me. Would you raise up a PR there?

mxl · 2017-11-03T21:49:16Z

@tomchentw Thanks for the review! I'm back! lucasfs7/google-maps-infobox-module#8

mxl · 2017-11-13T06:29:45Z

@tomchentw It's ready for a final review and merging.

moorea · 2017-11-21T21:40:38Z

@mxl, you are a lifesaver! If I could buy you a beer, I would 🍺

NonMint · 2017-11-23T16:52:51Z

Fantastic! I was just hoping for typescript definitions for this plugin. @mxl well done!

tomchentw · 2017-11-24T03:14:50Z

@mxl you're definitely awesome creating all those PRs with a clear roadmap! Great job!
I haven't tried this myself but I trust you.

tomchentw · 2017-11-24T03:29:08Z

Released v9.3.0

mxl · 2017-11-24T10:39:46Z

Guys, thank you for the kind words! @tomchentw if there will be any issue with definitions feel free to ping me.

alecmev · 2017-11-24T15:16:28Z

types/index.d.ts

+        attribution?: google.maps.Attribution
+        clickable?: boolean
+        cursor?: string
+        draggable?: string


Should be boolean, no?

Yep, thanks! #710

itsdouges · 2017-11-30T13:45:32Z

@mxl hey mate, getting these errors when running:

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(77,29): error TS2304: Cannot find name 'Calculator'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(87,25): error TS2304: Cannot find name 'ClusterIconStyle'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(93,22): error TS2304: Cannot find name 'Calculator'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(103,18): error TS2304: Cannot find name 'ClusterIconStyle'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(107,27): error TS2304: Cannot find name 'Cluster'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(110,24): error TS2304: Cannot find name 'Cluster'.

ERROR in /Users/madou/projects/a/node_modules/react-google-maps/types/index.d.ts
(111,25): error TS2304: Cannot find name 'Cluster'.

missing defs - oversight or something on my end?

moorea · 2017-11-30T14:52:21Z

@Madou, sounds like you need to install the latest version of MarkerClustererPlus. Check out mxl’s first comments on this PR. He had to add some stuff there as well. Best of luck 👍🏻

itsdouges · 2017-11-30T21:19:45Z

@moorea right you are, thanks!

mxl · 2017-12-01T19:39:37Z

@moorea I included @types/markerclustererplus and @types/googlemaps in peerDependencies to avoid unnecessary dependencies for those who does not use TypeScript.

phillipj · 2017-12-13T12:19:41Z

@mxl mind elaborating the added value of making those peerDependencies? I assume those type definitions isn't required for using this wonderful package?

$ npm install

..

npm WARN react-google-maps@9.4.2 requires a peer of @types/googlemaps@^3.0.0 but none was installed.
npm WARN react-google-maps@9.4.2 requires a peer of @types/markerclustererplus@^2.1.29 but none was installed.

As we're not using Typescript in that project (or any other for that matter), installing Typescript definitions is not something we want. Most importantly, we don't want to ignore npm warnings either 🤔

mxl · 2017-12-17T00:17:31Z

@phillipj Actually without those dependencies one will get compilation errors as @Madou did so we can not just remove them from package.json. Maybe it will be simpler for everyone to move them to dependencies. This will remove warnings for those who use JavaScript and errors for those who use TypeScript. WDYT?

phillipj · 2017-12-19T22:29:59Z

@mxl yupp, at first glance that sounds like a better option to me 👍 Although we non-typescript-users would have to download a couple of superfluous packages, we won't have to explicitly install them as our own dependencies.

kentaromiura · 2017-12-20T03:01:43Z

Just having this issue and searching bring me here as npm list will show peer dependencies as UNMET PEER DEPENDENCY;

@mxl I think that if you remove the type definitions from peerDependencies and just leave them in devDependencies should work and make everyone happy :)

mxl · 2017-12-20T11:50:05Z

@kentaromiura This will remove UNMET PEER DEPENDENCY warnings but will not install those dependencies. So developers will have to manually navigate this package package.json and install missing definitions. I see only two ways to make package work "out of the box" for both JS and TS developers:

move peerDependencies to dependencies;
move definitions to separate package.

@tomchentw WDYT?

tomchentw · 2018-01-04T14:29:03Z

@mxl I don't have strong opinion on this. Is there any disadvantage using dependencies over peerDependencies? I can think one is outdated dependencies. Any thoughts?

tomchentw · 2018-01-04T14:29:27Z

Let's move the typings discussion to #737

AbhaysinghBhosale · 2021-05-05T12:52:28Z

Is this issues still tracked. Not sure if this library is still maintained

mxl mentioned this pull request Oct 5, 2017

Create TypeScript definitions #363

Closed

tomchentw reviewed Oct 6, 2017

View reviewed changes

mxl force-pushed the typescript-definitions branch from 1b51ecc to acc309c Compare October 6, 2017 23:20

Add TypeScript definitions.

552d7e3

mxl force-pushed the typescript-definitions branch from acc309c to 552d7e3 Compare November 13, 2017 06:23

mxl changed the title ~~[WIP] Typescript definitions~~ Typescript definitions Nov 13, 2017

mxl mentioned this pull request Nov 13, 2017

strict-export-declare-modifiers false positive with declare module and export microsoft/dtslint#88

Open

tomchentw merged commit 072b4c7 into tomchentw:master Nov 24, 2017

mxl deleted the typescript-definitions branch November 24, 2017 10:41

alecmev reviewed Nov 24, 2017

View reviewed changes

tomchentw mentioned this pull request Nov 26, 2017

InfoBox: TypeError GoogleMapsInfoBox is not a constructor #711

Closed

tomchentw mentioned this pull request Jan 4, 2018

Typings peerDependencies #737

Open

mxl mentioned this pull request Jun 4, 2018

setting up project - yarn install - error Couldn't find match for "typescript-definitions" in "_c" for "https://github.com/mxl/react-google-maps.git" mxl/react-google-maps-example#1

Open

mxl restored the typescript-definitions branch August 3, 2019 09:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Typescript definitions #646

Typescript definitions #646

mxl commented Oct 5, 2017 •

edited

Loading

tomchentw Oct 6, 2017

mxl Oct 6, 2017

mxl commented Oct 6, 2017

tomchentw commented Oct 17, 2017

mxl commented Nov 3, 2017

mxl commented Nov 13, 2017

moorea commented Nov 21, 2017

NonMint commented Nov 23, 2017

tomchentw commented Nov 24, 2017

tomchentw commented Nov 24, 2017

mxl commented Nov 24, 2017

alecmev Nov 24, 2017

mxl Nov 24, 2017

itsdouges commented Nov 30, 2017 •

edited

Loading

moorea commented Nov 30, 2017

itsdouges commented Nov 30, 2017

mxl commented Dec 1, 2017

phillipj commented Dec 13, 2017

mxl commented Dec 17, 2017

phillipj commented Dec 19, 2017

kentaromiura commented Dec 20, 2017 •

edited

Loading

mxl commented Dec 20, 2017

tomchentw commented Jan 4, 2018

tomchentw commented Jan 4, 2018

AbhaysinghBhosale commented May 5, 2021


		export function withGoogleMap<P>(wrappedComponent: string \| ComponentClass<P> \| StatelessComponent<P>): ComponentClass<P & WithGoogleMapProps>

		export interface GoogleMapProps {

Typescript definitions #646

Typescript definitions #646

Conversation

mxl commented Oct 5, 2017 • edited Loading

tomchentw Oct 6, 2017

Choose a reason for hiding this comment

mxl Oct 6, 2017

Choose a reason for hiding this comment

mxl commented Oct 6, 2017

tomchentw commented Oct 17, 2017

mxl commented Nov 3, 2017

mxl commented Nov 13, 2017

moorea commented Nov 21, 2017

NonMint commented Nov 23, 2017

tomchentw commented Nov 24, 2017

tomchentw commented Nov 24, 2017

mxl commented Nov 24, 2017

alecmev Nov 24, 2017

Choose a reason for hiding this comment

mxl Nov 24, 2017

Choose a reason for hiding this comment

itsdouges commented Nov 30, 2017 • edited Loading

moorea commented Nov 30, 2017

itsdouges commented Nov 30, 2017

mxl commented Dec 1, 2017

phillipj commented Dec 13, 2017

mxl commented Dec 17, 2017

phillipj commented Dec 19, 2017

kentaromiura commented Dec 20, 2017 • edited Loading

mxl commented Dec 20, 2017

tomchentw commented Jan 4, 2018

tomchentw commented Jan 4, 2018

AbhaysinghBhosale commented May 5, 2021

mxl commented Oct 5, 2017 •

edited

Loading

itsdouges commented Nov 30, 2017 •

edited

Loading

kentaromiura commented Dec 20, 2017 •

edited

Loading