InputFunction
The input
function allows declaration of inputs in directives and
components.
interface InputFunction {
required: {...}
<T>(): InputSignal<T | undefined>
<T>(initialValue: T, opts?: InputOptionsWithoutTransform<T>): InputSignal<T>
<T, TransformT>(initialValue: T, opts: InputOptionsWithTransform<T, TransformT>): InputSignalWithTransform<T, TransformT>
}
Description
The function exposes an API for also declaring required inputs via the
input.required
function.
Properties
Property | Description |
---|---|
required: {
<T>(opts?: InputOptionsWithoutTransform<T>): InputSignal<T>;
<T, TransformT>(opts: InputOptionsWithTransform<T, TransformT>): InputSignalWithTransform<T, TransformT>;
}
|
Initializes a required input. Consumers of your directive/component need to bind to this input. If unset, a compile time error will be reported. |
Methods
call signature | ||||||
---|---|---|---|---|---|---|
Initializes an input of type |
||||||
ParametersThere are no parameters. Returns
|
||||||
Declares an input of type
Parameters
Returns |
||||||
Declares an input of type
Parameters
Returns |
||||||
The input accepts values of type |