@evolu/common 8.2.0 → 8.3.0

package/src/Object.ts

@@ -279,6 +279,8 @@ export function createMutableRecord<
   K extends string = string,
   V = unknown,
 >(): Record<K, V>;
+
+/** Creates a mutable null-prototype copy of an object. */
 export function createMutableRecord<T extends object>(
   source: T,
 ): { -readonly [K in keyof T]: T[K] };

package/src/RefCount.ts

@@ -88,6 +88,8 @@ export interface CreateRefCountByKeyOptions<
 
 /** Creates {@link RefCountByKey}. */
 export function createRefCountByKey<TKey = unknown>(): RefCountByKey<TKey>;
+
+/** Creates {@link RefCountByKey} with custom logical key lookup. */
 export function createRefCountByKey<TKey, L>(
   options: CreateRefCountByKeyOptions<TKey, L>,
 ): RefCountByKey<TKey>;

package/src/Relation.ts

@@ -181,6 +181,8 @@ export interface CreateRelationOptions<A, B, LA = A, LB = B> {
 
 /** Creates a {@link Relation}. */
 export function createRelation<A, B>(): Relation<A, B>;
+
+/** Creates a {@link Relation} with custom logical key lookups. */
 export function createRelation<A, B, LA, LB>(
   options: CreateRelationOptions<A, B, LA, LB>,
 ): Relation<A, B>;
@@ -371,6 +373,8 @@ export interface RefCountedRelation<A, B> {
 
 /** Creates a {@link RefCountedRelation}. */
 export function createRefCountedRelation<A, B>(): RefCountedRelation<A, B>;
+
+/** Creates a {@link RefCountedRelation} with custom logical key lookups. */
 export function createRefCountedRelation<A, B, LA, LB>(
   options: CreateRelationOptions<A, B, LA, LB>,
 ): RefCountedRelation<A, B>;

package/src/Resource.ts

@@ -705,6 +705,8 @@ export function createSharedResourceByKey<
 >(
   create: (key: K) => Task<T, never, D>,
 ): Task<SharedResourceByKey<K, T>, never, D>;
+
+/** Creates {@link SharedResourceByKey} with lookup or lifecycle options. */
 export function createSharedResourceByKey<K, T extends Resource, D, L = K>(
   create: (key: K) => Task<T, never, D>,
   options: SharedResourceByKeyOptions<K, L>,