Add typedocs & fix copy/paste errors

This commit is contained in:
Yury Bondarenko
2022-09-28 14:38:16 +02:00
parent 68def61f20
commit d98a261985

View File

@@ -128,6 +128,9 @@ export class ApplyPatchObjectCacheAction implements Action {
} }
} }
/**
* An NgRx action to add dependent request UUIDs to a cached object
*/
export class AddDependentsObjectCacheAction implements Action { export class AddDependentsObjectCacheAction implements Action {
type = ObjectCacheActionTypes.ADD_DEPENDENTS; type = ObjectCacheActionTypes.ADD_DEPENDENTS;
payload: { payload: {
@@ -136,7 +139,7 @@ export class AddDependentsObjectCacheAction implements Action {
}; };
/** /**
* Create a new AddDependencyObjectCacheAction * Create a new AddDependentsObjectCacheAction
* *
* @param href the self link of a cached object * @param href the self link of a cached object
* @param dependentRequestUUIDs the UUID of the request that depends on this object * @param dependentRequestUUIDs the UUID of the request that depends on this object
@@ -149,12 +152,15 @@ export class AddDependentsObjectCacheAction implements Action {
} }
} }
/**
* An NgRx action to remove all dependent request UUIDs from a cached object
*/
export class RemoveDependentsObjectCacheAction implements Action { export class RemoveDependentsObjectCacheAction implements Action {
type = ObjectCacheActionTypes.REMOVE_DEPENDENTS; type = ObjectCacheActionTypes.REMOVE_DEPENDENTS;
payload: string; payload: string;
/** /**
* Create a new AddDependencyObjectCacheAction * Create a new RemoveDependentsObjectCacheAction
* *
* @param href the self link of a cached object for which to remove all dependent request UUIDs * @param href the self link of a cached object for which to remove all dependent request UUIDs
*/ */