tweak inline docs

effect-active
Rich Harris 3 weeks ago
parent 93cf4fbdc6
commit 75d41c78b7

@ -269,13 +269,15 @@ The `$effect.allowed` rune is an advanced feature that indicates whether or not
function onclick() {
console.log('after component setup', $effect.allowed()); // false
$effect.root(() => {
const destroy = $effect.root(() => {
console.log('in root effect', $effect.allowed()); // true
return () => {
console.log('in effect teardown', $effect.allowed()); // false
};
});
destroy();
}
</script>

@ -268,21 +268,23 @@ declare namespace $effect {
*
* function onclick() {
* console.log('after component setup', $effect.allowed()); // false
* }
* function ondblclick() {
* $effect.root(() => {
*
* const destroy = $effect.root(() => {
* console.log('in root effect', $effect.allowed()); // true
*
* return () => {
* console.log('in effect teardown', $effect.allowed()); // false
* }
* })();
* };
* });
*
* destroy();
* }
* </script>
*
* <button {onclick}>Click me!</button>
* <button {ondblclick}>Click me twice!</button>
* ```
*
* https://svelte.dev/docs/svelte/$effect#$effect.allowed
* @see {@link https://svelte.dev/docs/svelte/$effect#$effect.allowed Documentation}
*/
export function allowed(): boolean;
/**

@ -3447,21 +3447,23 @@ declare namespace $effect {
*
* function onclick() {
* console.log('after component setup', $effect.allowed()); // false
* }
* function ondblclick() {
* $effect.root(() => {
*
* const destroy = $effect.root(() => {
* console.log('in root effect', $effect.allowed()); // true
*
* return () => {
* console.log('in effect teardown', $effect.allowed()); // false
* }
* })();
* };
* });
*
* destroy();
* }
* </script>
*
* <button {onclick}>Click me!</button>
* <button {ondblclick}>Click me twice!</button>
* ```
*
* https://svelte.dev/docs/svelte/$effect#$effect.allowed
* @see {@link https://svelte.dev/docs/svelte/$effect#$effect.allowed Documentation}
*/
export function allowed(): boolean;
/**

Loading…
Cancel
Save