浏览代码

Add comments.

NaotoshiFujita 3 年之前
父节点
当前提交
0ecac46b94
共有 4 个文件被更改,包括 20 次插入11 次删除
  1. 10 0
      dist/types/index.d.ts
  2. 5 0
      src/js/types/components.ts
  3. 5 0
      src/js/types/events.ts
  4. 0 11
      src/js/types/module.d.ts

+ 10 - 0
dist/types/index.d.ts

@@ -583,6 +583,11 @@ interface SyncTarget {
     isParent?: boolean;
     isParent?: boolean;
 }
 }
 
 
+/**
+ * The interface for all components.
+ *
+ * @since 3.0.0
+ */
 interface Components {
 interface Components {
     [key: string]: BaseComponent;
     [key: string]: BaseComponent;
     Options: OptionsComponent;
     Options: OptionsComponent;
@@ -606,6 +611,11 @@ interface Components {
     Transition: TransitionComponent;
     Transition: TransitionComponent;
 }
 }
 
 
+/**
+ * The interface for all internal events.
+ *
+ * @since 3.0.0
+ */
 interface EventMap {
 interface EventMap {
     'mounted': () => void;
     'mounted': () => void;
     'ready': () => void;
     'ready': () => void;

+ 5 - 0
src/js/types/components.ts

@@ -19,6 +19,11 @@ import { WheelComponent } from '../components/Wheel/Wheel';
 import { BaseComponent, TransitionComponent } from './general';
 import { BaseComponent, TransitionComponent } from './general';
 
 
 
 
+/**
+ * The interface for all components.
+ *
+ * @since 3.0.0
+ */
 export interface Components {
 export interface Components {
   [ key: string ]: BaseComponent;
   [ key: string ]: BaseComponent;
   Options: OptionsComponent;
   Options: OptionsComponent;

+ 5 - 0
src/js/types/events.ts

@@ -4,6 +4,11 @@ import { Splide } from '../core/Splide/Splide';
 import { Options } from './options';
 import { Options } from './options';
 
 
 
 
+/**
+ * The interface for all internal events.
+ *
+ * @since 3.0.0
+ */
 export interface EventMap {
 export interface EventMap {
   'mounted': () => void;
   'mounted': () => void;
   'ready': () => void;
   'ready': () => void;

+ 0 - 11
src/js/types/module.d.ts

@@ -1,11 +0,0 @@
-// /**
-//  * Explicitly declares the module for extensions.
-//  *
-//  * @since 3.6.7
-//  */
-// declare module '@splidejs/splide' {
-//   interface Components {}
-//   interface Options extends ResponsiveOptions {}
-//   interface ResponsiveOptions {}
-//   interface EventMap {}
-// }