Add strong typing to `TweenBuilderConfig` callback types

Aperta
#7,251 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

Inizia individuando la definizione di TweenBuilderConfig e le dichiarazioni dei tipi di callback di Phaser.Types.Tweens a cui si fa riferimento nell’issue. Esamina come sono attualmente esposti i target, gli scope dei callback, i parametri dei callback e le opzioni tipizzate come Function. Il lavoro è completo quando la configurazione fornisce una tipizzazione più forte per target e callback senza gli usi non sicuri di any e Function descritti nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

🐛 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.

Lingua principale
JavaScript
Stelle
40.7k
Fork
7.2k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di phaserjs/phaser

Tutte le issue di phaserjs/phaser

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.