msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

Convert src/runtime/internal/dev.ts to JavaScript

Browse Source
pull/8569/head
S. Elliott Johnson 3 years ago
parent c7fd1c69d2
commit ea4e7931e4
1 changed files with 264 additions and 295 deletions
Show Stats Download Patch File Download Diff File

359
src/runtime/internal/dev.ts
Unescape View File

@ -1,131 +1,170 @@
import { import { custom_event, append, append_hydration, insert, insert_hydration, detach, listen, attr } from './dom';
custom_event,
append,
append_hydration,
insert,
insert_hydration,
detach,
listen,
attr
} from './dom';
import { SvelteComponent } from './Component'; import { SvelteComponent } from './Component';
import { is_void } from '../../shared/utils/names'; import { is_void } from '../../shared/utils/names';
import { contenteditable_truthy_values } from './utils'; import { contenteditable_truthy_values } from './utils';
/** @param {string} type
export function dispatch_dev<T = any>(type: string, detail?: T) { * @param {T} detail
document.dispatchEvent( * @returns {void}
custom_event(type, { version: '__VERSION__', ...detail }, { bubbles: true }) */
); export function dispatch_dev(type, detail) {
document.dispatchEvent(custom_event(type, { version: '__VERSION__', ...detail }, { bubbles: true }));
} }
/** @param {Node} target
export function append_dev(target: Node, node: Node) { * @param {Node} node
* @returns {void}
*/
export function append_dev(target, node) {
dispatch_dev('SvelteDOMInsert', { target, node }); dispatch_dev('SvelteDOMInsert', { target, node });
append(target, node); append(target, node);
} }
/** @param {Node} target
export function append_hydration_dev(target: Node, node: Node) { * @param {Node} node
* @returns {void}
*/
export function append_hydration_dev(target, node) {
dispatch_dev('SvelteDOMInsert', { target, node }); dispatch_dev('SvelteDOMInsert', { target, node });
append_hydration(target, node); append_hydration(target, node);
} }
/** @param {Node} target
export function insert_dev(target: Node, node: Node, anchor?: Node) { * @param {Node} node
* @param {Node} anchor
* @returns {void}
*/
export function insert_dev(target, node, anchor) {
dispatch_dev('SvelteDOMInsert', { target, node, anchor }); dispatch_dev('SvelteDOMInsert', { target, node, anchor });
insert(target, node, anchor); insert(target, node, anchor);
} }
/** @param {Node} target
export function insert_hydration_dev(target: Node, node: Node, anchor?: Node) { * @param {Node} node
* @param {Node} anchor
* @returns {void}
*/
export function insert_hydration_dev(target, node, anchor) {
dispatch_dev('SvelteDOMInsert', { target, node, anchor }); dispatch_dev('SvelteDOMInsert', { target, node, anchor });
insert_hydration(target, node, anchor); insert_hydration(target, node, anchor);
} }
/** @param {Node} node
export function detach_dev(node: Node) { * @returns {void}
*/
export function detach_dev(node) {
dispatch_dev('SvelteDOMRemove', { node }); dispatch_dev('SvelteDOMRemove', { node });
detach(node); detach(node);
} }
/** @param {Node} before
export function detach_between_dev(before: Node, after: Node) { * @param {Node} after
* @returns {void}
*/
export function detach_between_dev(before, after) {
while (before.nextSibling && before.nextSibling !== after) { while (before.nextSibling && before.nextSibling !== after) {
detach_dev(before.nextSibling); detach_dev(before.nextSibling);
} }
} }
/** @param {Node} after
export function detach_before_dev(after: Node) { * @returns {void}
*/
export function detach_before_dev(after) {
while (after.previousSibling) { while (after.previousSibling) {
detach_dev(after.previousSibling); detach_dev(after.previousSibling);
} }
} }
/** @param {Node} before
export function detach_after_dev(before: Node) { * @returns {void}
*/
export function detach_after_dev(before) {
while (before.nextSibling) { while (before.nextSibling) {
detach_dev(before.nextSibling); detach_dev(before.nextSibling);
} }
} }
/** @param {Node} node
export function listen_dev( * @param {string} event
node: Node, * @param {EventListenerOrEventListenerObject} handler
event: string, * @param {boolean | AddEventListenerOptions | EventListenerOptions} options
handler: EventListenerOrEventListenerObject, * @param {boolean} has_prevent_default
options?: boolean | AddEventListenerOptions | EventListenerOptions, * @param {boolean} has_stop_propagation
has_prevent_default?: boolean, * @param {boolean} has_stop_immediate_propagation
has_stop_propagation?: boolean, * @returns {() => void}
has_stop_immediate_propagation?: boolean */
) { export function listen_dev(node, event, handler, options, has_prevent_default, has_stop_propagation, has_stop_immediate_propagation) {
const modifiers = const modifiers = options === true ? ['capture'] : options ? Array.from(Object.keys(options)) : [];
options === true ? ['capture'] : options ? Array.from(Object.keys(options)) : []; if (has_prevent_default)
if (has_prevent_default) modifiers.push('preventDefault'); modifiers.push('preventDefault');
if (has_stop_propagation) modifiers.push('stopPropagation'); if (has_stop_propagation)
if (has_stop_immediate_propagation) modifiers.push('stopImmediatePropagation'); modifiers.push('stopPropagation');
if (has_stop_immediate_propagation)
modifiers.push('stopImmediatePropagation');
dispatch_dev('SvelteDOMAddEventListener', { node, event, handler, modifiers }); dispatch_dev('SvelteDOMAddEventListener', { node, event, handler, modifiers });
const dispose = listen(node, event, handler, options); const dispose = listen(node, event, handler, options);
return () => { return () => {
dispatch_dev('SvelteDOMRemoveEventListener', { node, event, handler, modifiers }); dispatch_dev('SvelteDOMRemoveEventListener', { node, event, handler, modifiers });
dispose(); dispose();
}; };
} }
/** @param {Element} node
export function attr_dev(node: Element, attribute: string, value?: string) { * @param {string} attribute
* @param {string} value
* @returns {void}
*/
export function attr_dev(node, attribute, value) {
attr(node, attribute, value); attr(node, attribute, value);
if (value == null)
if (value == null) dispatch_dev('SvelteDOMRemoveAttribute', { node, attribute }); dispatch_dev('SvelteDOMRemoveAttribute', { node, attribute });
else dispatch_dev('SvelteDOMSetAttribute', { node, attribute, value }); else
} dispatch_dev('SvelteDOMSetAttribute', { node, attribute, value });
}
export function prop_dev(node: Element, property: string, value?: any) { /** @param {Element} node
* @param {string} property
* @param {any} value
* @returns {void}
*/
export function prop_dev(node, property, value) {
node[property] = value; node[property] = value;
dispatch_dev('SvelteDOMSetProperty', { node, property, value }); dispatch_dev('SvelteDOMSetProperty', { node, property, value });
} }
/** @param {HTMLElement} node
export function dataset_dev(node: HTMLElement, property: string, value?: any) { * @param {string} property
* @param {any} value
* @returns {void}
*/
export function dataset_dev(node, property, value) {
node.dataset[property] = value; node.dataset[property] = value;
dispatch_dev('SvelteDOMSetDataset', { node, property, value }); dispatch_dev('SvelteDOMSetDataset', { node, property, value });
} }
/** @param {Text} text
export function set_data_dev(text: Text, data: unknown) { * @param {unknown} data
* @returns {void}
*/
export function set_data_dev(text, data) {
data = '' + data; data = '' + data;
if (text.data === data) return; if (text.data === data)
return;
dispatch_dev('SvelteDOMSetData', { node: text, data }); dispatch_dev('SvelteDOMSetData', { node: text, data });
text.data = data as string; text.data = data;
} }
/** @param {Text} text
export function set_data_contenteditable_dev(text: Text, data: unknown) { * @param {unknown} data
* @returns {void}
*/
export function set_data_contenteditable_dev(text, data) {
data = '' + data; data = '' + data;
if (text.wholeText === data) return; if (text.wholeText === data)
return;
dispatch_dev('SvelteDOMSetData', { node: text, data }); dispatch_dev('SvelteDOMSetData', { node: text, data });
text.data = data as string; text.data = data;
} }
/** @param {Text} text
export function set_data_maybe_contenteditable_dev(text: Text, data: unknown, attr_value: string) { * @param {unknown} data
* @param {string} attr_value
* @returns {void}
*/
export function set_data_maybe_contenteditable_dev(text, data, attr_value) {
if (~contenteditable_truthy_values.indexOf(attr_value)) { if (~contenteditable_truthy_values.indexOf(attr_value)) {
set_data_contenteditable_dev(text, data); set_data_contenteditable_dev(text, data);
} else { }
else {
set_data_dev(text, data); set_data_dev(text, data);
} }
} }
/** @returns {void} */
export function validate_each_argument(arg) { export function validate_each_argument(arg) {
if (typeof arg !== 'string' && !(arg && typeof arg === 'object' && 'length' in arg)) { if (typeof arg !== 'string' && !(arg && typeof arg === 'object' && 'length' in arg)) {
let msg = '{#each} only iterates over array-like objects.'; let msg = '{#each} only iterates over array-like objects.';
@ -135,7 +174,7 @@ export function validate_each_argument(arg) {
throw new Error(msg); throw new Error(msg);
} }
} }
/** @returns {void} */
export function validate_slots(name, slot, keys) { export function validate_slots(name, slot, keys) {
for (const slot_key of Object.keys(slot)) { for (const slot_key of Object.keys(slot)) {
if (!~keys.indexOf(slot_key)) { if (!~keys.indexOf(slot_key)) {
@ -143,20 +182,24 @@ export function validate_slots(name, slot, keys) {
} }
} }
} }
/** @param {unknown} tag
export function validate_dynamic_element(tag: unknown) { * @returns {void}
*/
export function validate_dynamic_element(tag) {
const is_string = typeof tag === 'string'; const is_string = typeof tag === 'string';
if (tag && !is_string) { if (tag && !is_string) {
throw new Error('<svelte:element> expects "this" attribute to be a string.'); throw new Error('<svelte:element> expects "this" attribute to be a string.');
} }
} }
/** @param {undefined | string} tag
export function validate_void_dynamic_element(tag: undefined | string) { * @returns {void}
*/
export function validate_void_dynamic_element(tag) {
if (tag && is_void(tag)) { if (tag && is_void(tag)) {
console.warn(`<svelte:element this="${tag}"> is self-closing and cannot have content.`); console.warn(`<svelte:element this="${tag}"> is self-closing and cannot have content.`);
} }
} }
/** @returns {any} */
export function construct_svelte_component_dev(component, props) { export function construct_svelte_component_dev(component, props) {
const error_message = 'this={...} of <svelte:component> should specify a Svelte component.'; const error_message = 'this={...} of <svelte:component> should specify a Svelte component.';
try { try {
@ -165,42 +208,17 @@ export function construct_svelte_component_dev(component, props) {
throw new Error(error_message); throw new Error(error_message);
} }
return instance; return instance;
} catch (err) { }
catch (err) {
const { message } = err; const { message } = err;
if (typeof message === 'string' && message.indexOf('is not a constructor') !== -1) { if (typeof message === 'string' && message.indexOf('is not a constructor') !== -1) {
throw new Error(error_message); throw new Error(error_message);
} else {
throw err;
}
} }
else {
throw err;
} }
export interface SvelteComponentDev<
Props extends Record<string, any> = any,
Events extends Record<string, any> = any,
Slots extends Record<string, any> = any // eslint-disable-line @typescript-eslint/no-unused-vars
> {
$set(props?: Partial<Props>): void;
$on<K extends Extract<keyof Events, string>>(
type: K,
callback: ((e: Events[K]) => void) | null | undefined
): () => void;
$destroy(): void;
[accessor: string]: any;
} }
export interface ComponentConstructorOptions<
Props extends Record<string, any> = Record<string, any>
> {
target: Element | Document | ShadowRoot;
anchor?: Element;
props?: Props;
context?: Map<any, any>;
hydrate?: boolean;
intro?: boolean;
$$inline?: boolean;
} }
/** /**
* Base class for Svelte components with some minor dev-enhancements. Used when dev=true. * Base class for Svelte components with some minor dev-enhancements. Used when dev=true.
* *
@ -224,130 +242,55 @@ export interface ComponentConstructorOptions<
* </script> * </script>
* <MyComponent foo={'bar'} /> * <MyComponent foo={'bar'} />
* ``` * ```
* @extends SvelteComponent
*/ */
export class SvelteComponentDev< export class SvelteComponentDev extends SvelteComponent {
Props extends Record<string, any> = any,
Events extends Record<string, any> = any,
Slots extends Record<string, any> = any
> extends SvelteComponent {
/** /**
* @private * @private
* For type checking capabilities only. * For type checking capabilities only.
* Does not exist at runtime. * Does not exist at runtime.
* ### DO NOT USE! * ### DO NOT USE!
*/ */
$$prop_def: Props; $$prop_def = undefined;
/** /**
* @private * @private
* For type checking capabilities only. * For type checking capabilities only.
* Does not exist at runtime. * Does not exist at runtime.
* ### DO NOT USE! * ### DO NOT USE!
*/ */
$$events_def: Events; $$events_def = undefined;
/** /**
* @private * @private
* For type checking capabilities only. * For type checking capabilities only.
* Does not exist at runtime. * Does not exist at runtime.
* ### DO NOT USE! * ### DO NOT USE!
*/ */
$$slot_def: Slots; $$slot_def = undefined;
constructor(options) {
constructor(options: ComponentConstructorOptions<Props>) {
if (!options || (!options.target && !options.$$inline)) { if (!options || (!options.target && !options.$$inline)) {
throw new Error("'target' is a required option"); throw new Error("'target' is a required option");
} }
super(); super();
} }
/** @returns {void} */
$destroy() { $destroy() {
super.$destroy(); super.$destroy();
this.$destroy = () => { this.$destroy = () => {
console.warn('Component was already destroyed'); // eslint-disable-line no-console console.warn('Component was already destroyed'); // eslint-disable-line no-console
}; };
} }
/** @returns {void} */
$capture_state() { } $capture_state() { }
/** @returns {void} */
$inject_state() { } $inject_state() { }
} }
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface SvelteComponentTyped<
Props extends Record<string, any> = any,
Events extends Record<string, any> = any,
Slots extends Record<string, any> = any
> extends SvelteComponentDev<Props, Events, Slots> {}
/** /**
* @deprecated Use `SvelteComponent` instead. See PR for more information: https://github.com/sveltejs/svelte/pull/8512 * @deprecated Use `SvelteComponent` instead. See PR for more information: https://github.com/sveltejs/svelte/pull/8512
* @extends SvelteComponentDev<Props, Events, Slots>
*/ */
export class SvelteComponentTyped< export class SvelteComponentTyped extends SvelteComponentDev {
Props extends Record<string, any> = any, }
Events extends Record<string, any> = any, /** @returns {() => void} */
Slots extends Record<string, any> = any
> extends SvelteComponentDev<Props, Events, Slots> {}
/**
* Convenience type to get the type of a Svelte component. Useful for example in combination with
* dynamic components using `<svelte:component>`.
*
* Example:
* ```html
* <script lang="ts">
* import type { ComponentType, SvelteComponent } from 'svelte';
* import Component1 from './Component1.svelte';
* import Component2 from './Component2.svelte';
*
* const component: ComponentType = someLogic() ? Component1 : Component2;
* const componentOfCertainSubType: ComponentType<SvelteComponent<{ needsThisProp: string }>> = someLogic() ? Component1 : Component2;
* </script>
*
* <svelte:component this={component} />
* <svelte:component this={componentOfCertainSubType} needsThisProp="hello" />
* ```
*/
export type ComponentType<Component extends SvelteComponentDev = SvelteComponentDev> = (new (
options: ComponentConstructorOptions<
Component extends SvelteComponentDev<infer Props> ? Props : Record<string, any>
>
) => Component) & {
/** The custom element version of the component. Only present if compiled with the `customElement` compiler option */
element?: typeof HTMLElement;
};
/**
* Convenience type to get the props the given component expects. Example:
* ```html
* <script lang="ts">
* import type { ComponentProps } from 'svelte';
* import Component from './Component.svelte';
*
* const props: ComponentProps<Component> = { foo: 'bar' }; // Errors if these aren't the correct props
* </script>
* ```
*/
export type ComponentProps<Component extends SvelteComponent> =
Component extends SvelteComponentDev<infer Props> ? Props : never;
/**
* Convenience type to get the events the given component expects. Example:
* ```html
* <script lang="ts">
* import type { ComponentEvents } from 'svelte';
* import Component from './Component.svelte';
*
* function handleCloseEvent(event: ComponentEvents<Component>['close']) {
* console.log(event.detail);
* }
* </script>
*
* <Component on:close={handleCloseEvent} />
* ```
*/
export type ComponentEvents<Component extends SvelteComponent> =
Component extends SvelteComponentDev<any, infer Events> ? Events : never;
export function loop_guard(timeout) { export function loop_guard(timeout) {
const start = Date.now(); const start = Date.now();
return () => { return () => {
@ -356,3 +299,29 @@ export function loop_guard(timeout) {
} }
}; };
} }
/**
* @typedef {Class<HTMLElement>} ComponentType
* @template {SvelteComponentDev} [Component=SvelteComponentDev]
*/
/**
* @typedef {Component extends SvelteComponentDev<infer Props> ? Props : never} ComponentProps
* @template {SvelteComponent} Component
*/
/**
* @typedef {Component extends SvelteComponentDev<any, infer Events> ? Events : never} ComponentEvents
* @template {SvelteComponent} Component
*/
/** @typedef {Object} SvelteComponentDev */
/** @typedef {Object} ComponentConstructorOptions
* @property {Element|Document|ShadowRoot} target
* @property {Element} [anchor]
* @property {Props} [props]
* @property {Map<any,any>} [context]
* @property {boolean} [hydrate]
* @property {boolean} [intro]
* @property {boolean} [$$inline]
*/
/** @typedef {Object} SvelteComponentTyped */
Write Preview
Loading…
Cancel
Save