Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(types): Add jsdoc plugin to handle ts-style imports #8225

Merged
merged 3 commits into from
Apr 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"class": "link-vjs"
},
{
"title": "v8.0.2 source",
"title": "v8.2.1 source",
"link": "https://github.com/videojs/video.js",
"class": "link-gh"
},
Expand Down Expand Up @@ -59,6 +59,7 @@
}
},
"plugins": [
"node_modules/jsdoc-tsimport-plugin/index.js",
"plugins/markdown",
"build/jsdoc-typeof-plugin"
],
Expand Down
277 changes: 7 additions & 270 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
"husky": "^1.3.1",
"is-ci": "^3.0.0",
"jsdoc": "^3.6.11",
"jsdoc-tsimport-plugin": "^1.0.5",
"karma": "^6.4.0",
"lint-staged": "^10.5.4",
"markdown-table": "^1.1.3",
Expand Down
6 changes: 1 addition & 5 deletions src/js/big-play-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ import Button from './button.js';
import Component from './component.js';
import {isPromise, silencePromise} from './utils/promise';

/**
* @typedef {import('../event-target').Event} Event
*/

/**
* The initial play button that shows before the video has played. The hiding of the
* `BigPlayButton` get done via CSS and `Player` states.
Expand Down Expand Up @@ -38,7 +34,7 @@ class BigPlayButton extends Button {
* This gets called when a `BigPlayButton` "clicked". See {@link ClickableComponent}
* for more detailed information on what a click can be.
*
* @param {Event} event
* @param {KeyboardEvent} event
* The `keydown`, `tap`, or `click` event that caused this function to be
* called.
*
Expand Down
6 changes: 1 addition & 5 deletions src/js/clickable-component.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ import * as Dom from './utils/dom.js';
import log from './utils/log.js';
import keycode from 'keycode';

/**
* @typedef { import('./player').default } Player
*/

/**
* Component which is clickable or keyboard actionable, but is not a
* native HTML button.
Expand All @@ -21,7 +17,7 @@ class ClickableComponent extends Component {
/**
* Creates an instance of this class.
*
* @param {Player} player
* @param { import('./player').default } player
* The `Player` that this class should be attached to.
*
* @param {Object} [options]
Expand Down
Loading