Add typings for TypeScript interop #11
Conversation
There was a problem hiding this comment.
This is awesome! 🙌 Thank you so much & for the kind words 😃
Going to leave a few comments. While I'm sure these work, I'd like to mold them into a setup I'm more familiar with/used to seeing.... largely because I don't actually use TS but I can speak to/debug on behalf of what I've worked with before.
PS: Sorry for the delay on reviewing. I've been chasing down other rabbit holes
ganalytics.d.ts
Outdated
| @@ -0,0 +1,53 @@ | |||
| interface IGAnalyticsOptions { | |||
ganalytics.d.ts
Outdated
| ds?: string; | ||
| } | ||
|
|
||
| interface IGAnalytics { |
ganalytics.d.ts
Outdated
| * @param options Options | ||
| * @param toWait When truthy, a pageview event will not be sent immediately upon initialization. | ||
| */ | ||
| function GAnalyticsFactory(trackerID: string, options?: IGAnalyticsOptions, toWait?: boolean): IGAnalytics; |
There was a problem hiding this comment.
I think this can be options?: Partial<IGAnalyticsOptions> ?
ganalytics.d.ts
Outdated
| } | ||
|
|
||
| interface IGAnalytics { | ||
| send: (kind: "pageview" | "event", params?: any) => void; |
There was a problem hiding this comment.
There's actually a lot more kinds that can be sent. Here's the list: https://github.com/lukeed/ganalytics#type
So let's add a new Enum here:
send: (kind: EventType, params?: object) => voidAlso,
paramscan only be an object.
| * Indicates the data source type of the hit; eg web or app. | ||
| * See [Data Source](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#ds). | ||
| */ | ||
| ds?: string; |
There was a problem hiding this comment.
With the Partial keyword, we don't have to add ? to every key
|
The additional exports are because I know that someone will undoubtedly ask for them, so we might as well jump the gun here 😆 As for general setup, I don't think we necessarily need the namespace? Might be mistaken here. But GAnalytics will work with/without export type EventType = 'send' | 'pageview' | ...;
export interface Options {
// ...
}
export interface GAnalytics {
send: (type: EventType, params?: object) => void;
}
declare const ganalytics: (trackerID: string, options?: Partial<Options>, toWait?: boolean): GAnalytics;
export default ganalytics; |
|
Hi, @lukeed ! 👋 Also, I modified commit message according to yours |
|
Hi @lukeed! 👋 How about merging this PR? |
|
Hi! So sorry 🙈 thank you for the ping! This is super awesome & very very much appreciated 😄 I was using it today and found some errors and incomplete sections, but I will merge this as is ATM. I'll apply the fixes soon after – likely today. I have a bunch of them already locally. Thank you thank you 🙌 |
|
Thanks a bunch! |
Hi, Luke
Epic thanks for this wonderful alternative to default GA client!
I use this package with TypeScript and while it hasn't typings I forced to copy-paste my types.d.ts from project to project. It would be great if you merge this PR to make this awesome library support TypeScript.
Thanks!