UseCompletionReturn
Defined in: types.ts:276
Completion hook return value.
Properties
Section titled “Properties”complete()
Section titled “complete()”complete: (
prompt,options?) =>Promise<string|null|undefined>
Defined in: types.ts:288
Complete programmatically
Parameters
Section titled “Parameters”prompt
Section titled “prompt”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string | null | undefined>
completion
Section titled “completion”completion:
string
Defined in: types.ts:278
Current completion
optionaldata:unknown[]
Defined in: types.ts:301
Data from API
error:
Error|undefined
Defined in: types.ts:299
Error if any
handleInputChange()
Section titled “handleInputChange()”handleInputChange: (
e) =>void
Defined in: types.ts:284
Handle input change
Parameters
Section titled “Parameters”ChangeEvent<HTMLInputElement | HTMLTextAreaElement>
Returns
Section titled “Returns”void
handleSubmit()
Section titled “handleSubmit()”handleSubmit: (
e?) =>void
Defined in: types.ts:286
Handle form submit
Parameters
Section titled “Parameters”FormEvent<HTMLFormElement>
Returns
Section titled “Returns”void
input:
string
Defined in: types.ts:280
Current input
isLoading
Section titled “isLoading”isLoading:
boolean
Defined in: types.ts:297
Whether currently loading
setCompletion()
Section titled “setCompletion()”setCompletion: (
completion) =>void
Defined in: types.ts:295
Set completion
Parameters
Section titled “Parameters”completion
Section titled “completion”string
Returns
Section titled “Returns”void
setInput()
Section titled “setInput()”setInput: (
input) =>void
Defined in: types.ts:282
Set input
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop: () =>
void
Defined in: types.ts:293
Stop streaming
Returns
Section titled “Returns”void