From 20b62ad3e3a05f8704db592a3cc688a7d3c22ef4 Mon Sep 17 00:00:00 2001 From: Harvey Zhao Date: Fri, 13 Jun 2025 20:38:14 +0800 Subject: [PATCH] refactor(types): improve definitions (#971) --- packages/artplayer/types/config.d.ts | 5 ++++- packages/artplayer/types/option.d.ts | 4 ++-- packages/artplayer/types/player.d.ts | 4 ++-- packages/artplayer/types/quality.d.ts | 2 +- packages/artplayer/types/setting.d.ts | 2 +- 5 files changed, 10 insertions(+), 7 deletions(-) diff --git a/packages/artplayer/types/config.d.ts b/packages/artplayer/types/config.d.ts index 585195a10..4ddac7074 100644 --- a/packages/artplayer/types/config.d.ts +++ b/packages/artplayer/types/config.d.ts @@ -1,5 +1,8 @@ export type Config = { - propertys: [ + /** + * Supported video properties + */ + properties: [ 'audioTracks', 'autoplay', 'buffered', diff --git a/packages/artplayer/types/option.d.ts b/packages/artplayer/types/option.d.ts index b31b3f88a..60dcba9bb 100644 --- a/packages/artplayer/types/option.d.ts +++ b/packages/artplayer/types/option.d.ts @@ -3,7 +3,7 @@ import { Setting } from './setting'; import { Icons } from './icons'; import { I18n } from './i18n'; import { CssVar } from './cssVar'; -import { quality } from './quality'; +import { Quality } from './quality'; import { ComponentOption } from './component'; import Artplayer = require('./artplayer'); @@ -250,7 +250,7 @@ export type Option = { /** * Custom video quality list */ - quality?: quality[]; + quality?: Quality[]; /** * Custom highlight list diff --git a/packages/artplayer/types/player.d.ts b/packages/artplayer/types/player.d.ts index ae399982d..dcf6385b6 100644 --- a/packages/artplayer/types/player.d.ts +++ b/packages/artplayer/types/player.d.ts @@ -1,6 +1,6 @@ import { CssVar } from './cssVar'; import { CustomType, Thumbnails } from './option'; -import { quality } from './quality'; +import { Quality } from './quality'; export type AspectRatio = 'default' | '4:3' | '16:9' | (`${number}:${number}` & Record); export type PlaybackRate = 0.5 | 0.75 | 1.0 | 1.25 | 1.5 | 1.75 | 2.0 | (number & Record); @@ -62,7 +62,7 @@ export declare class Player { get subtitleOffset(): number; set subtitleOffset(time: number); set switch(url: string); - set quality(quality: quality[]); + set quality(quality: Quality[]); get thumbnails(): Thumbnails; set thumbnails(thumbnails: Thumbnails); pause(): void; diff --git a/packages/artplayer/types/quality.d.ts b/packages/artplayer/types/quality.d.ts index 04c86c0ee..d0179b5dc 100644 --- a/packages/artplayer/types/quality.d.ts +++ b/packages/artplayer/types/quality.d.ts @@ -1,4 +1,4 @@ -export type quality = { +export type Quality = { /** * Whether the default is selected */ diff --git a/packages/artplayer/types/setting.d.ts b/packages/artplayer/types/setting.d.ts index 2ef10fd99..aa426c7c8 100644 --- a/packages/artplayer/types/setting.d.ts +++ b/packages/artplayer/types/setting.d.ts @@ -51,7 +51,7 @@ export type Setting = { selector?: Setting[]; /** - * Wnen the setting was mounted + * When the setting was mounted */ mounted?(this: Artplayer, panel: HTMLDivElement, item: Setting): void;