github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-25 22:53:56 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

DEV: Improve JSDoc for withPluginApi (#29758)

Browse Source 
This allows consumers to get intellisense completions on the `api.` argument of their callback
This commit is contained in:
David Taylor 2024-11-14 17:20:23 +00:00 committed by GitHub
parent fd1220af69
commit f70cc6215c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
app/assets/javascripts/discourse/app/lib/plugin-api.gjs
View File

@ -3362,7 +3362,6 @@ class PluginApi {
registeredTabs.push(tab); registeredTabs.push(tab);
} }
// eslint-disable-next-line no-unused-vars
#deprecatedWidgetOverride(widgetName, override) { #deprecatedWidgetOverride(widgetName, override) {
// insert here the code to handle widget deprecations, e.g. for the header widgets we used: // insert here the code to handle widget deprecations, e.g. for the header widgets we used:
// if (DEPRECATED_HEADER_WIDGETS.includes(widgetName)) { // if (DEPRECATED_HEADER_WIDGETS.includes(widgetName)) {
@ -3436,11 +3435,12 @@ function getPluginApi(version) {
} }
/** /**
* withPluginApi(version, apiCodeCallback, opts) * Executes the provided callback function with the `PluginApi` object if the specified API version is available.
* *
* Helper to version our client side plugin API. Pass the version of the API that your * @param {number} version - The version of the API that the plugin is coded against.
* plugin is coded against. If that API is available, the `apiCodeCallback` function will * @param {(api: PluginApi, opts: object) => void} apiCodeCallback - The callback function to execute if the API version is available
* be called with the `PluginApi` object. * @param {object} [opts] - Optional additional options to pass to the callback function.
* @returns {*} The result of the `callback` function, if executed
*/ */
export function withPluginApi(version, apiCodeCallback, opts) { export function withPluginApi(version, apiCodeCallback, opts) {
opts = opts || {}; opts = opts || {};