feat(agera,kida): mark certain functions as no side effects

Author: dangreen

packages/agera/src/effect.ts

@@ -147,6 +147,7 @@ export function effectScope(
  * Create effect scope runner which will share the same scope instance.
  * @returns The effect scope runner.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function createEffectScope() {
   return runEffectScopeInstance.bind(null, createEffectScopeInstance()) as typeof effectScope
 }

packages/agera/src/signal.ts

@@ -94,6 +94,7 @@ export function signal<T>(): WritableSignal<T | undefined>
  */
 export function signal<T>(value: T): WritableSignal<T>
 
+/* @__NO_SIDE_EFFECTS__ */
 export function signal<T>(value?: T): WritableSignal<T | undefined> {
   return createSignal(signalGetterSetter, {
     [$$value]: value,
@@ -129,6 +130,7 @@ function signalGetterSetter<T>(this: Signal<T>, ...value: [T]): T | void {
  * @param compute - The function to compute the value.
  * @returns A signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function computed<T>(compute: Compute<T>): ReadableSignal<T> {
   return createSignal(computedGetter, {
     [$$value]: undefined,
@@ -165,6 +167,7 @@ export function morph<T, C extends Partial<Morph<T>>>(
   context: C
 ): ReadableSignal<T>
 
+/* @__NO_SIDE_EFFECTS__ */
 export function morph<T, C extends Partial<Morph<T>>>(
   $signal: WritableSignal<T>,
   context: C

packages/kida/src/channel.ts

@@ -52,6 +52,7 @@ function abortableRun(
  * @param mapErrorValue - Function to map the error value. Default is to get the error message.
  * @returns A tuple with the task, state and error signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function channel<E = string>(
   tasks: TasksSet,
   mapErrorValue: (error: unknown) => E = error => (error as Error).message as E

packages/kida/src/external.ts

@@ -33,6 +33,7 @@ function lazyGetterSetter<T>(this: External<T>, ...value: [T]): T | void {
  * @param factory - The factory function.
  * @returns The external signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function external<T>(
   factory: ExternalFactory<T>
 ) {

packages/kida/src/lazy.ts

@@ -26,6 +26,7 @@ function lazyGetter<T>(this: Morph<T>) {
  * @param factory - The factory function.
  * @returns The lazy signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function lazy<T>(factory: LazyFactory<T>) {
   return morph(signal(factory as T), {
     [$$get]: lazyGetter

packages/kida/src/list.ts

@@ -30,6 +30,7 @@ export function atIndex<T>(
   index: number | ReadableSignal<number>
 ): ReadableSignal<T>
 
+/* @__NO_SIDE_EFFECTS__ */
 export function atIndex<T>(
   $list: ReadableSignal<T[]> | WritableSignal<T[]>,
   index: number | ReadableSignal<number>
@@ -101,6 +102,7 @@ export function unshift<T>($list: WritableSignal<T[]>, ...values: T[]) {
  * @param index - The index to get.
  * @returns The value at the index.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function getIndex<T>($list: ReadableSignal<T[]>, index: number) {
   return $list()[index]
 }
@@ -142,6 +144,7 @@ export function clearList<T>($list: WritableSignal<T[]>) {
  * @param value - The value to check.
  * @returns Whether the list signal includes the value.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function includes<T>($list: ReadableSignal<T[]>, value: T) {
   return $list().includes(value)
 }

packages/kida/src/map.ts

@@ -32,6 +32,7 @@ export function atKey<T extends AnyCollection>(
   key: keyof T | ReadableSignal<keyof T>
 ): ReadableSignal<T[keyof T]>
 
+/* @__NO_SIDE_EFFECTS__ */
 export function atKey<T extends AnyCollection>(
   $map: ReadableSignal<T> | WritableSignal<T>,
   key: keyof T | ReadableSignal<keyof T>
@@ -45,6 +46,7 @@ export function atKey<T extends AnyCollection>(
  * @param key - The key to get.
  * @returns The value.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function getKey<T extends AnyCollection>($map: ReadableSignal<T>, key: keyof T) {
   return $map()[key]
 }
@@ -97,6 +99,7 @@ export function clearMap<T extends AnyCollection>($map: WritableSignal<T>) {
  * @param key - The key to check.
  * @returns Whether the map signal has the key.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function has<T extends AnyCollection>($map: ReadableSignal<T>, key: keyof T) {
   return key in $map()
 }

packages/kida/src/paced.ts

@@ -11,6 +11,7 @@ import type { RateLimiter } from './types/index.js'
  * @param rateLimiter - The rate limiter function.
  * @returns The paced signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function paced<T>(
   $signal: WritableSignal<T>,
   rateLimiter: RateLimiter

packages/kida/src/record.ts

@@ -23,6 +23,7 @@ const flatHandler = /* @__PURE__ */ createProxyHandler(child => child)
  * @param source - Source signal.
  * @returns A record signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function record<T>(source: T) {
   return recordBase(toSignal(source), flatHandler) as T extends AnyWritableSignal
     ? WritableRecord<T>
@@ -39,6 +40,7 @@ const deepHandler = /* @__PURE__ */ createProxyHandler(deepRecord)
  * @param source - Source signal.
  * @returns A deep record signal.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function deepRecord<T>(source: T) {
   return recordBase(toSignal(source), deepHandler) as T extends AnyWritableSignal
     ? WritableDeepRecord<T>

packages/kida/src/tasks.ts

@@ -13,6 +13,7 @@ export function Tasks() {
  * @param tasks - Tasks queue.
  * @returns Promise that resolves when all running tasks are finished.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function allTasks(tasks: TasksSet) {
   return Promise.allSettled([...tasks])
 }
@@ -47,6 +48,7 @@ export function addTask<T = void>(
  * @param tasks - Tasks queue.
  * @returns The task runner.
  */
+/* @__NO_SIDE_EFFECTS__ */
 export function createTasksRunner(tasks: TasksSet) {
   return (fn: () => Promise<unknown>) => addTask(tasks, fn())
 }