Documentation / @agentick/core / useKnob

Function: useKnob()

Call Signature

useKnob<T>(name, defaultValue, opts): [T, (value) => void]

Defined in: core/src/hooks/knob.ts:170

Create a knob (no resolver). Returns [value, setter].

Type Parameters

T

T extends KnobPrimitive

Parameters

name

string

defaultValue

T

opts

KnobOpts<T>

Returns

[T, (value) => void]

Call Signature

useKnob<T, R>(name, defaultValue, opts, resolve): [R, (value) => void]

Defined in: core/src/hooks/knob.ts:179

Create a knob with a resolver. Returns [resolvedValue, primitiveSetter].

Type Parameters

T

T extends KnobPrimitive

R

R

Parameters

name

string

defaultValue

T

opts

KnobOpts<T>

resolve

(value) => R

Returns

[R, (value) => void]

Call Signature

useKnob<T, R>(name, descriptor): [R, (value) => void]

Defined in: core/src/hooks/knob.ts:189

Create a knob from a KnobDescriptor. Returns [resolvedValue, primitiveSetter].

Type Parameters

T

T extends KnobPrimitive

R

R

Parameters

name

string

descriptor

KnobDescriptor<T, R>

Returns

[R, (value) => void]