Skip to content

feat: $derived.by get current value as first argument #13250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gentle-mayflies-try.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'svelte': patch
---

feat: `$derived.by` get current value as first argument
2 changes: 1 addition & 1 deletion packages/svelte/src/ambient.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ declare namespace $derived {
*
* https://svelte-5-preview.vercel.app/docs/runes#$derived-by
*/
export function by<T>(fn: () => T): T;
export function by<T>(fn: (current: T | null) => T): T;

// prevent intellisense from being unhelpful
/** @deprecated */
Expand Down
10 changes: 0 additions & 10 deletions packages/svelte/src/compiler/utils/builders.js
Original file line number Diff line number Diff line change
Expand Up @@ -419,16 +419,6 @@ export function template(elements, expressions) {
* @returns {ESTree.Expression}
*/
export function thunk(expression, async = false) {
if (
expression.type === 'CallExpression' &&
expression.callee.type !== 'Super' &&
expression.callee.type !== 'MemberExpression' &&
expression.callee.type !== 'CallExpression' &&
expression.arguments.length === 0
) {
return expression.callee;
}

const fn = arrow([], expression);
if (async) fn.async = true;
return fn;
Expand Down
4 changes: 2 additions & 2 deletions packages/svelte/src/internal/client/reactivity/deriveds.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { inspect_effects, set_inspect_effects } from './sources.js';

/**
* @template V
* @param {() => V} fn
* @param {(current: V | null ) => V} fn
* @returns {Derived<V>}
*/
/*#__NO_SIDE_EFFECTS__*/
Expand Down Expand Up @@ -47,7 +47,7 @@ export function derived(fn) {

/**
* @template V
* @param {() => V} fn
* @param {(current: NoInfer<V> | null) => V} fn
* @returns {Derived<V>}
*/
/*#__NO_SIDE_EFFECTS__*/
Expand Down
2 changes: 1 addition & 1 deletion packages/svelte/src/internal/client/reactivity/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface Reaction extends Signal {

export interface Derived<V = unknown> extends Value<V>, Reaction {
/** The derived function */
fn: () => V;
fn: (current: V | null) => V;
/** Reactions created inside this signal */
children: null | Reaction[];
}
Expand Down
7 changes: 5 additions & 2 deletions packages/svelte/src/internal/client/runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,11 @@ export function update_reaction(reaction) {
derived_sources = null;

try {
var result = /** @type {Function} */ (0, reaction.fn)();
var args = [];
if (reaction.f & DERIVED) {
args.push(/**@type {Derived}*/ (reaction).v);
}
var result = /** @type {Function} */ (0, reaction.fn)(...args);
var deps = reaction.deps;

if (new_deps !== null) {
Expand Down Expand Up @@ -783,7 +787,6 @@ export function get(signal) {
update_derived(derived);
}
}

return signal.v;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/svelte/tests/signals/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ describe('signals', () => {
});

test('owned deriveds correctly cleanup when no longer connected to graph', () => {
let a: Derived<unknown>;
let a: Derived<void>;
let s = state(0);

const destroy = effect_root(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ export default function Svelte_element($$anchor, $$props) {
var fragment = $.comment();
var node = $.first_child(fragment);

$.element(node, tag, false);
$.element(node, () => tag(), false);
$.append($$anchor, fragment);
}
2 changes: 1 addition & 1 deletion packages/svelte/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2494,7 +2494,7 @@ declare namespace $derived {
*
* https://svelte-5-preview.vercel.app/docs/runes#$derived-by
*/
export function by<T>(fn: () => T): T;
export function by<T>(fn: (current: T | null) => T): T;

// prevent intellisense from being unhelpful
/** @deprecated */
Expand Down