Refine JSDoc / TypeScript types for plugins #324
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Would it make sense to add https://getanalytics.io/resources/faq/#do-i-need-to-use-a-plugin There was a problem hiding this comment. Well, maybe? Doesn't seem like this PR is getting any attention from the library maintainer so I'm not sure making any changes to it makes practical sense. There was a problem hiding this comment. Yeah, it seems like issues and PRs are increasing. I'm sure @DavidWells is just busy at the moment. Maybe it's time for a call for maintainers? 🤔 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,70 @@ | ||
| /** | ||
| * @callback PluginTrackFunction | ||
| * @param {Object} arg | ||
| * @param {Object} arg.config config from the plugin spec | ||
| * @param {AnalyticsInstance} arg.instance analytics instance | ||
| * @param {Object} arg.payload event data | ||
| * @param {string} arg.payload.event event name passed to track | ||
| * @param {Object.<string,Object>} arg.payload.properties event properties passed to track | ||
| * @return {void} | ||
| */ | ||
|
|
||
| /** | ||
| * @callback PluginPageFunction | ||
| * @param {Object} arg | ||
| * @param {Object} arg.config config from the plugin spec | ||
| * @param {AnalyticsInstance} arg.instance analytics instance | ||
| * @param {Object} arg.payload | ||
| * @param {string} arg.payload.event | ||
| * @param {PageData} arg.payload.properties | ||
| * @return {void} | ||
| */ | ||
|
|
||
| /** | ||
| * @callback PluginIdentifyFunction | ||
| * @param {Object} arg | ||
| * @param {Object} arg.config config from the plugin spec | ||
| * @param {AnalyticsInstance} arg.instance analytics instance | ||
| * @param {Object} arg.payload | ||
| * @param {string} arg.payload.userId | ||
| * @param {Object.<string,Object>} arg.payload.traits | ||
| * @return {void} | ||
| */ | ||
|
|
||
| /** | ||
| * @callback PluginInitializeFunction | ||
| * @param {Object} arg | ||
| * @param {Object} arg.config config from the plugin spec | ||
| * @param {AnalyticsInstance} arg.instance analytics instance | ||
| * @return boolean | ||
| */ | ||
|
|
||
| /** | ||
| * @callback PluginLoadedFunction | ||
| * @param {Object} arg | ||
| * @param {Object} arg.config config from the plugin spec | ||
| * @param {AnalyticsInstance} arg.instance analytics instance | ||
| * @param {Object} arg.payload | ||
| * @return boolean | ||
| */ | ||
|
|
||
| /** | ||
| * @callback PluginReadyFunction | ||
| * @param {Object} arg | ||
| * @param {Object} arg.config config from the plugin spec | ||
| * @param {AnalyticsInstance} arg.instance analytics instance | ||
| * @return void | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {Object} AnalyticsPlugin | ||
| * @property {string} name - Name of plugin | ||
| * @property {Object} [EVENTS] - exposed events of plugin | ||
| * @property {Object} [config] - Configuration of plugin | ||
| * @property {function} [initialize] - Load analytics scripts method | ||
| * @property {PluginPageFunction} [page] - Page visit tracking method | ||
| * @property {PluginTrackFunction} [track] - Custom event tracking method | ||
| * @property {PluginIdentifyFunction} [identify] - User identify method | ||
| * @property {PluginLoadedFunction} [loaded] - Function to determine if analytics script loaded | ||
| * @property {PluginReadyFunction} [ready] - Fire function when plugin ready | ||
|
Comment on lines
+65
to
+69
There was a problem hiding this comment. Should there be one of these for every event named in |
||
| */ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This conflicted with the built-in type
Storageused forlocalStorage&sessionStorageso I took the liberty of renaming it while I was in here to fix the TypeScript error I got. Hopefully that's OK.