useParameter

Returns the current value of a parameter in a data object. Parameter values can be set using the data object's setParameter method.

API

import { DataObject, RetrieveParameters } from "@olenbetong/appframe-data";
/**
 * Returns the value of a parameter in the data object.
 *
 * @param dataObject Data object to get the parameter value from
 * @param parameter The parameter to get from the data object
 * @returns The current value of the given parameter
 */
export declare function useParameter<T, P extends keyof RetrieveParameters<T>>(
  dataObject: DataObject<T>,
  parameter: P
): RetrieveParameters<T>[P];