@trackunit/react-core-hooks 0.2.38 → 0.2.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/runtimes/useCustomFieldRuntimeForEntity.d.ts +3 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-core-hooks",
3
- "version": "0.2.38",
3
+ "version": "0.2.39",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "module": "./index.js",
package/src/runtimes/useCustomFieldRuntimeForEntity.d.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  import { ValueAndDefinition } from "@trackunit/iris-app-runtime-core";
2
2
  import { EntityIdentity, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
3
3
  /**
4
- * Hook for getting and setting custom fields for an entity
4
+ * This hook is a wrapper around useCustomFieldRuntime that automatically fetches and sets custom fields for a given entity.
5
5
  *
6
- * @param entity the entity to use
7
- * @returns the hook for custom fields for the entity
6
+ * @param entity The entity to fetch and set custom fields for.
7
+ * @returns The custom fields for the entity, and functions to set custom fields for the entity.
8
8
  */
9
9
  export declare const useCustomFieldRuntimeForEntity: (entity: EntityIdentity) => {
10
10
  customFields: ValueAndDefinition[] | undefined;