Type Alias: TypedModelIdProp<T, THasSetter>
type TypedModelIdProp<T, THasSetter> = Omit<ModelProp<T, T | undefined, T, T | undefined, never, true, THasSetter>, "withSetter"> & object;
The type of idProp.
Type Declaration
typedAs()
typedAs<U>(): TypedModelIdProp<U, THasSetter>;
Same as idProp, except that it might have a specific TypeScript string template as type.
E.g. idProp.typedAs<custom-${string}>()
Type Parameters
| Type Parameter |
|---|
U extends string |
Returns
TypedModelIdProp<U, THasSetter>
withGenerator()
withGenerator(generator): TypedModelIdProp<T, THasSetter>;
Sets a custom generator for missing model IDs in this idProp.
Parameters
| Parameter | Type |
|---|---|
generator | () => T |
Returns
TypedModelIdProp<T, THasSetter>
withSetter()
Call Signature
withSetter(): TypedModelIdProp<T, string>;
Enables generation of a setter method for the ID prop (setId for id, setCustomId for customId).
Returns
TypedModelIdProp<T, string>
Call Signature
withSetter(valueTransform): TypedModelIdProp<T, string>;
Enables generation of a setter method for the ID prop and applies a value transform to setter input.
Parameters
| Parameter | Type |
|---|---|
valueTransform | ModelPropSetterValueTransform<T> |
Returns
TypedModelIdProp<T, string>
Call Signature
withSetter(mode): TypedModelIdProp<T, string>;
Parameters
| Parameter | Type |
|---|---|
mode | "assign" |
Returns
TypedModelIdProp<T, string>
Deprecated
Setter methods are preferred.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends string | string |
THasSetter | never |