entropic-bond 1.52.0 → 1.52.1

package/lib/persistent/persistent.d.ts

@@ -229,8 +229,31 @@ export declare function persistentReference(target: Persistent, property: string
  * @param storedInCollection indicates the path of the collection where this reference is stored
  * @see persistentReference
  * @see persistentPureReferenceWithCachedProps
+ * @sample
+ * class User extends Persistent {
+ * 	@persistentReferenceWithCachedProps( ['name', 'email'] ) private _friend: User
+ * }
+ */
+export declare function persistentReferenceWithCachedProps<T extends Persistent>(cachedProps: ClassPropNamesOfType<T, Primitive>[], storeInCollection?: string | CollectionPathCallback): (target: Persistent, property: string) => void;
+/**
+ * Decorator to declare a persistent reference (see @persistentReference) that stores
+ * the values in cachedProps as values in the reference object. If
+ * DataSource.installCachedPropsUpdaters has been called, the cached
+ * properties are updated in the background when the reference is updates.
+ * This is useful
+ * when you are not able to wait for population of referenced properties.
+ * @param propType The type of the referenced property or an instance of it
+ * @param cachedProps the properties whose values should be stored in the reference object
+ * @param storeInCollection indicates the path of the collection where this reference is stored
+ * @see persistentReference
+ * @see persistentPureReferenceWithCachedProps
+ * @see DataSource.installCachedPropsUpdaters
+ * @sample
+ * class User extends Persistent {
+ * 	@persistentReferenceWithUpgradableCachedProps( User, ['name', 'email'] ) private _friend: User
+ * }
  */
-export declare function persistentReferenceWithCachedProps<T extends Persistent>(propType: PersistentConstructor<T> | T, cachedProps: ClassPropNamesOfType<T, Primitive>[], storeInCollection?: string | CollectionPathCallback): (target: Persistent, property: string) => void;
+export declare function persistentReferenceWithUpdatableCachedProps<T extends Persistent>(propType: PersistentConstructor<T> | T, cachedProps: ClassPropNamesOfType<T, Primitive>[], storeInCollection?: string | CollectionPathCallback): (target: Persistent, property: string) => void;
 /**
  * Decorator for a property that is a reference to a persistent object.
  * In this case, and contrary to the @persistentReference decorator, the reference
@@ -254,7 +277,27 @@ export declare function persistentPureReference(target: Persistent, property: st
  * // the reference object will contain the properties name and email of the referenced user
  * // without having to populate the _friend property
  */
-export declare function persistentPureReferenceWithCachedProps<T extends Persistent>(propType: PersistentConstructor<T> | T, cachedProps: ClassPropNamesOfType<T, Primitive>[], storeInCollection?: string | CollectionPathCallback): (target: Persistent, property: string) => void;
+export declare function persistentPureReferenceWithCachedProps<T extends Persistent>(cachedProps: ClassPropNamesOfType<T, Primitive>[], storeInCollection?: string | CollectionPathCallback): (target: Persistent, property: string) => void;
+/**
+ * Decorator to declare a persistent property as a pure reference
+ * (see @persistentPureReference) that stores the values of the properties listed
+ * in cachedProps as values in the reference object. If
+ * DataSource.installCachedPropsUpdaters has been called, the cached
+ * properties are updated in the background when the reference is updates.
+ * This is useful when you only need a few properties to be available without
+ * needing to populate the referenced property.
+ * @param propType The type of the referenced property or an instance of it
+ * @param cachedProps the properties whose values should be stored in the reference object
+ * @param storedInCollection indicates the path of the collection where this reference is stored
+ * @see persistentReferenceWithCachedProps
+ * @see persistentPureReference
+ * @see DataSource.installCachedPropsUpdaters
+ * @sample
+ * class User extends Persistent {
+ * 	@persistentPureReferenceWithUpdatableCachedProps( User, ['name', 'email'] ) private _friend: User
+ * }
+ */
+export declare function persistentPureReferenceWithUpdatableCachedProps<T extends Persistent>(propType: PersistentConstructor<T> | T, cachedProps: ClassPropNamesOfType<T, Primitive>[], storeInCollection?: string | CollectionPathCallback): (target: Persistent, property: string) => void;
 export declare function persistentParser(options?: Partial<PersistentProperty>): (target: Persistent, property: string) => void;
 /**
  * Decorator to register a persistent class. Entropic Bond needs that you register

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "entropic-bond",
   "type": "module",
-  "version": "1.52.0",
+  "version": "1.52.1",
   "description": "Tidy up your messy components",
   "main": "./lib/entropic-bond.umd.cjs",
   "module": "./lib/entropic-bond.js",