chore: use JSDoc import (#12595)

* more * more * more
sveltejs · Jul 24, 2024 · c173140 · c173140
1 parent 8d13921
commit c173140
Show file tree

Hide file tree

Showing 12 changed files with 88 additions and 77 deletions.
diff --git a/packages/svelte/src/internal/client/dom/blocks/each.js b/packages/svelte/src/internal/client/dom/blocks/each.js
@@ -59,7 +59,7 @@ export function index(_, i) {
  * @param {EachState} state
  * @param {EachItem[]} items
  * @param {null | Node} controlled_anchor
- * @param {Map<any, import("#client").EachItem>} items_map
+ * @param {Map<any, EachItem>} items_map
  */
 function pause_effects(state, items, controlled_anchor, items_map) {
 	/** @type {TransitionManager[]} */

diff --git a/packages/svelte/src/internal/client/dom/blocks/if.js b/packages/svelte/src/internal/client/dom/blocks/if.js
@@ -1,4 +1,4 @@
-/** @import { TemplateNode } from '#client' */
+/** @import { Effect, TemplateNode } from '#client' */
 import { EFFECT_TRANSPARENT } from '../../constants.js';
 import {
 	hydrate_next,
@@ -14,8 +14,8 @@ import { HYDRATION_START_ELSE } from '../../../../constants.js';
 /**
  * @param {TemplateNode} node
  * @param {() => boolean} get_condition
- * @param {(anchor: Node) => import('#client').Dom} consequent_fn
- * @param {null | ((anchor: Node) => import('#client').Dom)} [alternate_fn]
+ * @param {(anchor: Node) => void} consequent_fn
+ * @param {null | ((anchor: Node) => void)} [alternate_fn]
  * @param {boolean} [elseif] True if this is an `{:else if ...}` block rather than an `{#if ...}`, as that affects which transitions are considered 'local'
  * @returns {void}
  */
@@ -26,10 +26,10 @@ export function if_block(node, get_condition, consequent_fn, alternate_fn = null
 
 	var anchor = node;
 
-	/** @type {import('#client').Effect | null} */
+	/** @type {Effect | null} */
 	var consequent_effect = null;
 
-	/** @type {import('#client').Effect | null} */
+	/** @type {Effect | null} */
 	var alternate_effect = null;
 
 	/** @type {boolean | null} */

diff --git a/packages/svelte/src/internal/client/dom/elements/transitions.js b/packages/svelte/src/internal/client/dom/elements/transitions.js
@@ -1,3 +1,4 @@
+/** @import { AnimateFn, Animation, AnimationConfig, EachItem, Effect, Task, TransitionFn, TransitionManager } from '#client' */
 import { noop, is_function } from '../../../shared/utils.js';
 import { effect } from '../../reactivity/effects.js';
 import { current_effect, untrack } from '../../runtime.js';
@@ -60,19 +61,19 @@ const linear = (t) => t;
  * and attaches it to the block, so that moves can be animated following reconciliation.
  * @template P
  * @param {Element} element
- * @param {() => import('#client').AnimateFn<P | undefined>} get_fn
+ * @param {() => AnimateFn<P | undefined>} get_fn
  * @param {(() => P) | null} get_params
  */
 export function animation(element, get_fn, get_params) {
-	var item = /** @type {import('#client').EachItem} */ (current_each_item);
+	var item = /** @type {EachItem} */ (current_each_item);
 
 	/** @type {DOMRect} */
 	var from;
 
 	/** @type {DOMRect} */
 	var to;
 
-	/** @type {import('#client').Animation | undefined} */
+	/** @type {Animation | undefined} */
 	var animation;
 
 	/** @type {null | { position: string, width: string, height: string, transform: string }} */
@@ -167,7 +168,7 @@ export function animation(element, get_fn, get_params) {
  * @template P
  * @param {number} flags
  * @param {HTMLElement} element
- * @param {() => import('#client').TransitionFn<P | undefined>} get_fn
+ * @param {() => TransitionFn<P | undefined>} get_fn
  * @param {(() => P) | null} get_params
  * @returns {void}
  */
@@ -180,15 +181,15 @@ export function transition(flags, element, get_fn, get_params) {
 	/** @type {'in' | 'out' | 'both'} */
 	var direction = is_both ? 'both' : is_intro ? 'in' : 'out';
 
-	/** @type {import('#client').AnimationConfig | ((opts: { direction: 'in' | 'out' }) => import('#client').AnimationConfig) | undefined} */
+	/** @type {AnimationConfig | ((opts: { direction: 'in' | 'out' }) => AnimationConfig) | undefined} */
 	var current_options;
 
 	var inert = element.inert;
 
-	/** @type {import('#client').Animation | undefined} */
+	/** @type {Animation | undefined} */
 	var intro;
 
-	/** @type {import('#client').Animation | undefined} */
+	/** @type {Animation | undefined} */
 	var outro;
 
 	/** @type {(() => void) | undefined} */
@@ -201,7 +202,7 @@ export function transition(flags, element, get_fn, get_params) {
 		return (current_options ??= get_fn()(element, get_params?.(), { direction }));
 	}
 
-	/** @type {import('#client').TransitionManager} */
+	/** @type {TransitionManager} */
 	var transition = {
 		is_global,
 		in() {
@@ -271,7 +272,7 @@ export function transition(flags, element, get_fn, get_params) {
 		}
 	};
 
-	var e = /** @type {import('#client').Effect} */ (current_effect);
+	var e = /** @type {Effect} */ (current_effect);
 
 	(e.transitions ??= []).push(transition);
 
@@ -282,7 +283,7 @@ export function transition(flags, element, get_fn, get_params) {
 		let run = is_global;
 
 		if (!run) {
-			var block = /** @type {import('#client').Effect | null} */ (e.parent);
+			var block = /** @type {Effect | null} */ (e.parent);
 
 			// skip over transparent blocks (e.g. snippets, else-if blocks)
 			while (block && (block.f & EFFECT_TRANSPARENT) !== 0) {
@@ -305,12 +306,12 @@ export function transition(flags, element, get_fn, get_params) {
 /**
  * Animates an element, according to the provided configuration
  * @param {Element} element
- * @param {import('#client').AnimationConfig | ((opts: { direction: 'in' | 'out' }) => import('#client').AnimationConfig)} options
- * @param {import('#client').Animation | undefined} counterpart The corresponding intro/outro to this outro/intro
+ * @param {AnimationConfig | ((opts: { direction: 'in' | 'out' }) => AnimationConfig)} options
+ * @param {Animation | undefined} counterpart The corresponding intro/outro to this outro/intro
  * @param {number} t2 The target `t` value — `1` for intro, `0` for outro
  * @param {(() => void) | undefined} on_finish Called after successfully completing the animation
  * @param {(() => void) | undefined} on_abort Called if the animation is aborted
- * @returns {import('#client').Animation}
+ * @returns {Animation}
  */
 function animate(element, options, counterpart, t2, on_finish, on_abort) {
 	var is_intro = t2 === 1;
@@ -319,7 +320,7 @@ function animate(element, options, counterpart, t2, on_finish, on_abort) {
 		// In the case of a deferred transition (such as `crossfade`), `option` will be
 		// a function rather than an `AnimationConfig`. We need to call this function
 		// once DOM has been updated...
-		/** @type {import('#client').Animation} */
+		/** @type {Animation} */
 		var a;
 
 		queue_micro_task(() => {
@@ -358,10 +359,10 @@ function animate(element, options, counterpart, t2, on_finish, on_abort) {
 	var duration = options.duration * Math.abs(delta);
 	var end = start + duration;
 
-	/** @type {Animation} */
+	/** @type {globalThis.Animation} */
 	var animation;
 
-	/** @type {import('#client').Task} */
+	/** @type {Task} */
 	var task;
 
 	if (css) {

diff --git a/packages/svelte/src/internal/client/reactivity/deriveds.js b/packages/svelte/src/internal/client/reactivity/deriveds.js
@@ -1,3 +1,4 @@
+/** @import { Derived } from '#client' */
 import { CLEAN, DERIVED, DESTROYED, DIRTY, MAYBE_DIRTY, UNOWNED } from '../constants.js';
 import {
 	current_reaction,
@@ -16,14 +17,14 @@ export let updating_derived = false;
 /**
  * @template V
  * @param {() => V} fn
- * @returns {import('#client').Derived<V>}
+ * @returns {Derived<V>}
  */
 /*#__NO_SIDE_EFFECTS__*/
 export function derived(fn) {
 	let flags = DERIVED | DIRTY;
 	if (current_effect === null) flags |= UNOWNED;
 
-	/** @type {import('#client').Derived<V>} */
+	/** @type {Derived<V>} */
 	const signal = {
 		deps: null,
 		deriveds: null,
@@ -38,7 +39,7 @@ export function derived(fn) {
 	};
 
 	if (current_reaction !== null && (current_reaction.f & DERIVED) !== 0) {
-		var current_derived = /** @type {import('#client').Derived} */ (current_reaction);
+		var current_derived = /** @type {Derived} */ (current_reaction);
 		if (current_derived.deriveds === null) {
 			current_derived.deriveds = [signal];
 		} else {
@@ -52,7 +53,7 @@ export function derived(fn) {
 /**
  * @template V
  * @param {() => V} fn
- * @returns {import('#client').Derived<V>}
+ * @returns {Derived<V>}
  */
 /*#__NO_SIDE_EFFECTS__*/
 export function derived_safe_equal(fn) {
@@ -62,7 +63,7 @@ export function derived_safe_equal(fn) {
 }
 
 /**
- * @param {import('#client').Derived} derived
+ * @param {Derived} derived
  * @returns {void}
  */
 function destroy_derived_children(derived) {
@@ -79,7 +80,7 @@ function destroy_derived_children(derived) {
 }
 
 /**
- * @param {import('#client').Derived} derived
+ * @param {Derived} derived
  * @returns {void}
  */
 export function update_derived(derived) {
@@ -103,7 +104,7 @@ export function update_derived(derived) {
 }
 
 /**
- * @param {import('#client').Derived} signal
+ * @param {Derived} signal
  * @returns {void}
  */
 export function destroy_derived(signal) {