TS to JSDoc Conversion

src/runtime/action/index.ts → src/runtime/action/index.js

@@ -1,3 +1,9 @@
+export {};
+
+// Implementation notes:
+// - undefined extends X instead of X extends undefined makes this work better with both strict and nonstrict mode
+// - [X] extends [never] is needed, X extends never would reduce the whole resulting type to never and not to one of the condition outcomes
+
 /**
  * Actions can return an object containing the two properties defined in this interface. Both are optional.
  * - update: An action can have a parameter. This method will be called whenever that parameter changes,
@@ -25,21 +31,14 @@
  * ```
  *
  * Docs: https://svelte.dev/docs#template-syntax-element-directives-use-action
+ * @typedef {Object} ActionReturn
+ * @property {[Parameter] extends [never] ? never : (parameter: Parameter) => void} [update]
+ * @property {()=>void} [destroy]
+ * @property {Attributes} [$$_attributes]
+ * ### DO NOT USE THIS
+ * This exists solely for type-checking and has no effect at runtime.
+ * Set this through the `Attributes` generic instead.
  */
-export interface ActionReturn<
-	Parameter = never,
-	Attributes extends Record<string, any> = Record<never, any>
-> {
-	update?: [Parameter] extends [never] ? never : (parameter: Parameter) => void;
-	destroy?: () => void;
-	/**
-	 * ### DO NOT USE THIS
-	 * This exists solely for type-checking and has no effect at runtime.
-	 * Set this through the `Attributes` generic instead.
-	 */
-	$$_attributes?: Attributes;
-}
-
 /**
  * Actions are functions that are called when an element is created.
  * You can use this interface to type such actions.
@@ -56,21 +55,5 @@ export interface ActionReturn<
  * See interface `ActionReturn` for more details.
  *
  * Docs: https://svelte.dev/docs#template-syntax-element-directives-use-action
+ * @typedef {Object} Action
  */
-export interface Action<
-	Element = HTMLElement,
-	Parameter = never,
-	Attributes extends Record<string, any> = Record<never, any>
-> {
-	<Node extends Element>(
-		...args: [Parameter] extends [never]
-			? [node: Node]
-			: undefined extends Parameter
-			? [node: Node, parameter?: Parameter]
-			: [node: Node, parameter: Parameter]
-	): void | ActionReturn<Parameter, Attributes>;
-}
-
-// Implementation notes:
-// - undefined extends X instead of X extends undefined makes this work better with both strict and nonstrict mode
-// - [X] extends [never] is needed, X extends never would reduce the whole resulting type to never and not to one of the condition outcomes

src/runtime/animate/index.ts → src/runtime/animate/index.js

@@ -1,35 +1,19 @@
 import { cubicOut } from '../easing';
 import { is_function } from '../internal';
 
-// todo: same as Transition, should it be shared?
-export interface AnimationConfig {
-	delay?: number;
-	duration?: number;
-	easing?: (t: number) => number;
-	css?: (t: number, u: number) => string;
-	tick?: (t: number, u: number) => void;
-}
-
-export interface FlipParams {
-	delay?: number;
-	duration?: number | ((len: number) => number);
-	easing?: (t: number) => number;
-}
-
-export function flip(
-	node: Element,
-	{ from, to }: { from: DOMRect; to: DOMRect },
-	params: FlipParams = {}
-): AnimationConfig {
+/**
+ * @param {Element} node
+ * @param {{ from: DOMRect; to: DOMRect }}
+ * @param {FlipParams} params
+ * @returns {import("/Users/elliottjohnson/dev/sveltejs/svelte/index.ts-to-jsdoc").AnimationConfig}
+ */
+export function flip(node, { from, to }, params = {}) {
 	const style = getComputedStyle(node);
 	const transform = style.transform === 'none' ? '' : style.transform;
-
 	const [ox, oy] = style.transformOrigin.split(' ').map(parseFloat);
 	const dx = from.left + (from.width * ox) / to.width - (to.left + ox);
 	const dy = from.top + (from.height * oy) / to.height - (to.top + oy);
-
 	const { delay = 0, duration = (d) => Math.sqrt(d) * 120, easing = cubicOut } = params;
-
 	return {
 		delay,
 		duration: is_function(duration) ? duration(Math.sqrt(dx * dx + dy * dy)) : duration,
@@ -39,8 +23,23 @@ export function flip(
 			const y = u * dy;
 			const sx = t + (u * from.width) / to.width;
 			const sy = t + (u * from.height) / to.height;
-
 			return `transform: ${transform} translate(${x}px, ${y}px) scale(${sx}, ${sy});`;
 		}
 	};
 }
+
+/**
+ * @typedef {Object} AnimationConfig
+ * @property {number} [delay]
+ * @property {number} [duration]
+ * @property {(t:number)=>number} [easing]
+ * @property {(t:number,u:number)=>string} [css]
+ * @property {(t:number,u:number)=>void} [tick]
+ */
+
+/**
+ * @typedef {Object} FlipParams
+ * @property {number} [delay]
+ * @property {number|((len:number)=>number)} [duration]
+ * @property {(t:number)=>number} [easing]
+ */