Skip to content

Function: useProxiedModel()

ts
function useProxiedModel<Props, Prop, Inner>(
  props: Props,
  prop: Prop,
  defaultValue?: Props[Prop],
  transformIn?: (value?: Props[Prop]) => Inner,
  transformOut?: (value: Inner) => Props[Prop],
): Ref<InnerVal<Inner>, InnerVal<Inner>> & {
  externalValue: Props[Prop];
};

Type Parameters

Type ParameterDefault type
Props extends object & { [key in string as `onUpdate:${Prop}`]: ((args: any[]) => void) | undefined }-
Prop extends string-
InnerProps[Prop]

Parameters

ParameterType
propsProps
propProp
defaultValue?Props[Prop]
transformIn?(value?: Props[Prop]) => Inner
transformOut?(value: Inner) => Props[Prop]

Returns

Ref<InnerVal<Inner>, InnerVal<Inner>> & { externalValue: Props[Prop]; }