86 lines
3.9 KiB
Plaintext
86 lines
3.9 KiB
Plaintext
export declare let current_component: any;
|
|
export declare function set_current_component(component: any): void;
|
|
export declare function get_current_component(): any;
|
|
/**
|
|
* Schedules a callback to run immediately before the component is updated after any state change.
|
|
*
|
|
* The first time the callback runs will be before the initial `onMount`
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-beforeupdate
|
|
*/
|
|
export declare function beforeUpdate(fn: () => any): void;
|
|
/**
|
|
* The `onMount` function schedules a callback to run as soon as the component has been mounted to the DOM.
|
|
* It must be called during the component's initialisation (but doesn't need to live *inside* the component;
|
|
* it can be called from an external module).
|
|
*
|
|
* `onMount` does not run inside a [server-side component](/docs#run-time-server-side-component-api).
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-onmount
|
|
*/
|
|
export declare function onMount(fn: () => any): void;
|
|
/**
|
|
* Schedules a callback to run immediately after the component has been updated.
|
|
*
|
|
* The first time the callback runs will be after the initial `onMount`
|
|
*/
|
|
export declare function afterUpdate(fn: () => any): void;
|
|
/**
|
|
* Schedules a callback to run immediately before the component is unmounted.
|
|
*
|
|
* Out of `onMount`, `beforeUpdate`, `afterUpdate` and `onDestroy`, this is the
|
|
* only one that runs inside a server-side component.
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-ondestroy
|
|
*/
|
|
export declare function onDestroy(fn: () => any): void;
|
|
export interface DispatchOptions {
|
|
cancelable?: boolean;
|
|
}
|
|
/**
|
|
* Creates an event dispatcher that can be used to dispatch [component events](/docs#template-syntax-component-directives-on-eventname).
|
|
* Event dispatchers are functions that can take two arguments: `name` and `detail`.
|
|
*
|
|
* Component events created with `createEventDispatcher` create a
|
|
* [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent).
|
|
* These events do not [bubble](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events#Event_bubbling_and_capture).
|
|
* The `detail` argument corresponds to the [CustomEvent.detail](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/detail)
|
|
* property and can contain any type of data.
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-createeventdispatcher
|
|
*/
|
|
export declare function createEventDispatcher<EventMap extends {} = any>(): <EventKey extends Extract<keyof EventMap, string>>(type: EventKey, detail?: EventMap[EventKey], options?: DispatchOptions) => boolean;
|
|
/**
|
|
* Associates an arbitrary `context` object with the current component and the specified `key`
|
|
* and returns that object. The context is then available to children of the component
|
|
* (including slotted content) with `getContext`.
|
|
*
|
|
* Like lifecycle functions, this must be called during component initialisation.
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-setcontext
|
|
*/
|
|
export declare function setContext<T>(key: any, context: T): T;
|
|
/**
|
|
* Retrieves the context that belongs to the closest parent component with the specified `key`.
|
|
* Must be called during component initialisation.
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-getcontext
|
|
*/
|
|
export declare function getContext<T>(key: any): T;
|
|
/**
|
|
* Retrieves the whole context map that belongs to the closest parent component.
|
|
* Must be called during component initialisation. Useful, for example, if you
|
|
* programmatically create a component and want to pass the existing context to it.
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-getallcontexts
|
|
*/
|
|
export declare function getAllContexts<T extends Map<any, any> = Map<any, any>>(): T;
|
|
/**
|
|
* Checks whether a given `key` has been set in the context of a parent component.
|
|
* Must be called during component initialisation.
|
|
*
|
|
* https://svelte.dev/docs#run-time-svelte-hascontext
|
|
*/
|
|
export declare function hasContext(key: any): boolean;
|
|
export declare function bubble(component: any, event: any): void;
|