chore: document init parameters (#9118)

pull/9121/head
gtmnayan 11 months ago committed by GitHub
parent 6fe17eabf2
commit 3191147c2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -84,7 +84,17 @@ function make_dirty(component, i) {
component.$$.dirty[(i / 31) | 0] |= 1 << i % 31; component.$$.dirty[(i / 31) | 0] |= 1 << i % 31;
} }
/** @returns {void} */ // TODO: Document the other params
/**
* @param {SvelteComponent} component
* @param {import('./public.js').ComponentConstructorOptions} options
*
* @param {import('./utils.js')['not_equal']} not_equal Used to compare props and state values.
* @param {(target: Element | ShadowRoot) => void} [append_styles] Function that appends styles to the DOM when the component is first initialised.
* This will be the `add_css` function from the compiled component.
*
* @returns {void}
*/
export function init( export function init(
component, component,
options, options,
@ -92,7 +102,7 @@ export function init(
create_fragment, create_fragment,
not_equal, not_equal,
props, props,
append_styles, append_styles = null,
dirty = [-1] dirty = [-1]
) { ) {
const parent_component = current_component; const parent_component = current_component;
@ -139,8 +149,9 @@ export function init(
if (options.target) { if (options.target) {
if (options.hydrate) { if (options.hydrate) {
start_hydrating(); start_hydrating();
// TODO: what is the correct type here?
// @ts-expect-error
const nodes = children(options.target); const nodes = children(options.target);
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
$$.fragment && $$.fragment.l(nodes); $$.fragment && $$.fragment.l(nodes);
nodes.forEach(detach); nodes.forEach(detach);
} else { } else {

Loading…
Cancel
Save