breaking(TimerState): Rename onTick to tick

Author: techniq

.changeset/light-mice-brake.md

@@ -0,0 +1,5 @@
+---
+'@layerstack/svelte-state': patch
+---
+
+breaking(TimerState): Rename `onTick` to `tick`

packages/svelte-state/src/lib/timerState.svelte.ts

@@ -12,7 +12,7 @@ export type TimerOptions<T> = {
   disabled?: boolean;
 
   /** Called on each interval tick.  Returned value is used to update store value, defaulting to current Date */
-  onTick?: (current: T | null) => any;
+  tick?: (current: T | null) => any;
 };
 
 /**
@@ -25,14 +25,14 @@ export class TimerState<T = any> {
   #delay: number;
   #disabled: boolean;
   #running = $state(false);
-  #onTick: (current: T | null) => any;
+  #tick: (current: T | null) => any;
 
   constructor(options: TimerOptions<T> = {}) {
     this.#initial = options.initial ?? null;
     this.#current = this.#initial;
     this.#delay = options.delay ?? 1000;
     this.#disabled = options.disabled ?? false;
-    this.#onTick = options.onTick ?? (() => new Date());
+    this.#tick = options.tick ?? (() => new Date());
 
     if (!this.#disabled) {
       this.start();
@@ -68,7 +68,7 @@ export class TimerState<T = any> {
   start = () => {
     stop();
     this.#intervalId = setInterval(() => {
-      this.#current = this.#onTick(this.#current) ?? new Date();
+      this.#current = this.#tick(this.#current) ?? new Date();
     }, this.#delay);
     this.#running = true;
   };

sites/docs/src/routes/docs/svelte-state/TimerState/+page.svelte

@@ -5,16 +5,16 @@
   import Preview from '$docs/Preview.svelte';
   import Code from '$docs/Code.svelte';
 
-  const dateTimer = new TimerState({ initial: new Date(), onTick: () => new Date() });
-  const tickTimer = new TimerState({ initial: 0, onTick: (value) => (value ?? 0) + 1 });
+  const dateTimer = new TimerState({ initial: new Date() });
+  const tickTimer = new TimerState({ initial: 0, tick: (value) => (value ?? 0) + 1 });
 </script>
 
 <h1>Usage</h1>
 
 <Code source={`const timer = new TimerState();`} language="javascript" />
 
 <Code
-  source={`const timer = new TimerState<T>({ initial?: T, onTick?: (value: T) => {...}, delay?: number, disabled?: boolean })`}
+  source={`const timer = new TimerState<T>({ initial?: T, tick?: (value: T) => {...}, delay?: number, disabled?: boolean })`}
   language="javascript"
 />
 
@@ -38,7 +38,7 @@
 <h2>Tick count</h2>
 
 <Code
-  source={`const tickTimer = new TimerState({ initial: 0, onTick: (value) => value + 1 });`}
+  source={`const tickTimer = new TimerState({ initial: 0, tick: (value) => value + 1 });`}
   language="javascript"
 />