Add strong typing to `TweenBuilderConfig` callback types

Đang mở
#7,251 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 3 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu bằng cách tìm định nghĩa TweenBuilderConfig và các khai báo kiểu callback của Phaser.Types.Tweens được tham chiếu trong issue. Xem lại cách targets, callback scope, callback parameters và các tùy chọn có kiểu Function hiện được cung cấp. Hoàn thành khi cấu hình cung cấp kiểu mạnh hơn cho target và callback mà không sử dụng any và Function không an toàn như được mô tả trong issue.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

🐛 TypeScript Bug

The current type of TweenBuilder looks like this:

type TweenBuilderConfig = {[key: string]: any} & {
    /**
     * The object, or an array of objects, to run the tween on.
     */
    targets: any;
    /**
     * The number of milliseconds to delay before the tween will start.
     */
    delay?: number | Function;
    /**
     * The duration of the tween in milliseconds.
     */
    duration?: number;
    /**
     * The easing equation to use for the tween.
     */
    ease?: string | Function;
    /**
     * Optional easing parameters.
     */
    easeParams?: any[];
    /**
     * The number of milliseconds to hold the tween for before yoyo'ing.
     */
    hold?: number;
    /**
     * The number of times each property tween repeats.
     */
    repeat?: number;
    /**
     * The number of milliseconds to pause before a repeat.
     */
    repeatDelay?: number;
    /**
     * Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.
     */
    yoyo?: boolean;
    /**
     * Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.
     */
    flipX?: boolean;
    /**
     * Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.
     */
    flipY?: boolean;
    /**
     * The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
     */
    completeDelay?: string | number | Function | object | any[];
    /**
     * The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.
     */
    loop?: string | number | Function | object | any[];
    /**
     * The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
     */
    loopDelay?: string | number | Function | object | any[];
    /**
     * Does the tween start in a paused state (true) or playing (false)?
     */
    paused?: boolean;
    /**
     * The properties to tween.
     */
    props?: {[key: string]:  (number|string|Phaser.Types.Tweens.GetEndCallback|Phaser.Types.Tweens.TweenPropConfig)};
    /**
     * The scope (or context) for all of the callbacks. The default scope is the tween.
     */
    callbackScope?: any;
    /**
     * A function to call when the tween completes.
     */
    onComplete?: Phaser.Types.Tweens.TweenOnCompleteCallback;
    /**
     * Additional parameters to pass to `onComplete`.
     */
    onCompleteParams?: any[];
    /**
     * A function to call each time the tween loops.
     */
    onLoop?: Phaser.Types.Tweens.TweenOnLoopCallback;
    /**
     * Additional parameters to pass to `onLoop`.
     */
    onLoopParams?: any[];
    /**
     * A function to call each time a property tween repeats. Called once per property per target.
     */
    onRepeat?: Phaser.Types.Tweens.TweenOnRepeatCallback;
    /**
     * Additional parameters to pass to `onRepeat`.
     */
    onRepeatParams?: any[];
    /**
     * A function to call when the tween starts playback, after any delays have expired.
     */
    onStart?: Phaser.Types.Tweens.TweenOnStartCallback;
    /**
     * Additional parameters to pass to `onStart`.
     */
    onStartParams?: any[];
    /**
     * A function to call when the tween is stopped.
     */
    onStop?: Phaser.Types.Tweens.TweenOnStopCallback;
    /**
     * Additional parameters to pass to `onStop`.
     */
    onStopParams?: any[];
    /**
     * A function to call each time the tween steps. Called once per property per target.
     */
    onUpdate?: Phaser.Types.Tweens.TweenOnUpdateCallback;
    /**
     * Additional parameters to pass to `onUpdate`.
     */
    onUpdateParams?: any[];
    /**
     * A function to call each time a property tween yoyos. Called once per property per target.
     */
    onYoyo?: Phaser.Types.Tweens.TweenOnYoyoCallback;
    /**
     * Additional parameters to pass to `onYoyo`.
     */
    onYoyoParams?: any[];
    /**
     * A function to call when the tween becomes active within the Tween Manager.
     */
    onActive?: Phaser.Types.Tweens.TweenOnActiveCallback;
    /**
     * Additional parameters to pass to `onActive`.
     */
    onActiveParams?: any[];
    /**
     * A function to call when the tween is paused.
     */
    onPause?: Phaser.Types.Tweens.TweenOnPauseCallback;
    /**
     * Additional parameters to pass to `onPause`.
     */
    onPauseParams?: any[];
    /**
     * A function to call when the tween is resumed after being paused.
     */
    onResume?: Phaser.Types.Tweens.TweenOnResumeCallback;
    /**
     * Additional parameters to pass to `onResume`.
     */
    onResumeParams?: any[];
    /**
     * Will the Tween be automatically destroyed on completion, or retained for future playback?
     */
    persist?: boolean;
    /**
     * The interpolation function to use if the `value` given is an array of numbers.
     */
    interpolation?: string | Function;
};

This:

  • uses a value of any for target, which is unsafe.
  • uses any[] as the type for the "extra parameters" passed to various callbacks (and an any callback scope), which is type-unsafe and has poor heuristics; nothing will stop you from forgetting to pass an extra parameter to a callback (and producing undefined), or expecting target to be a different type as is expected.
  • Numerous uses of Function which provides no information about callback types or return values

In an ideal world, this should be generic on targets and the various callback parameter types.
Unfortunately, TS doesn't really make it easy to parameterize callback types without introducing many many type parameters, so we might need several @template declarations to get the job done.

Ngôn ngữ chính
JavaScript
Star
40.7k
Fork
7.2k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của phaserjs/phaser

Tất cả issue của phaserjs/phaser

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.