@flowscripter/dynamic-cli-framework
Preparing search index...
CompletionService
Interface CompletionService
Interface for a service providing shell auto-completion support.
interface
CompletionService
{
formatCompletions
(
shellType
:
ShellType
,
completions
:
readonly
CompletionItem
[]
,
)
:
string
;
generateCompletions
(
shellType
:
ShellType
,
line
:
string
,
cursorPosition
:
number
,
)
:
Promise
<
readonly
CompletionItem
[]
>
;
getBootstrapScript
(
shellType
:
ShellType
,
cliName
:
string
,
executablePath
:
string
,
)
:
string
;
getDefaultConfigPath
(
shellType
:
ShellType
)
:
string
;
validateShellEnvironment
(
shellType
:
ShellType
)
:
Promise
<
boolean
>
;
}
Implemented by
DefaultCompletionService
Index
Methods
format
Completions
generate
Completions
get
Bootstrap
Script
get
Default
Config
Path
validate
Shell
Environment
Methods
format
Completions
formatCompletions
(
shellType
:
ShellType
,
completions
:
readonly
CompletionItem
[]
,
)
:
string
Parameters
shellType
:
ShellType
completions
:
readonly
CompletionItem
[]
Returns
string
generate
Completions
generateCompletions
(
shellType
:
ShellType
,
line
:
string
,
cursorPosition
:
number
,
)
:
Promise
<
readonly
CompletionItem
[]
>
Parameters
shellType
:
ShellType
line
:
string
cursorPosition
:
number
Returns
Promise
<
readonly
CompletionItem
[]
>
get
Bootstrap
Script
getBootstrapScript
(
shellType
:
ShellType
,
cliName
:
string
,
executablePath
:
string
,
)
:
string
Parameters
shellType
:
ShellType
cliName
:
string
executablePath
:
string
Returns
string
get
Default
Config
Path
getDefaultConfigPath
(
shellType
:
ShellType
)
:
string
Parameters
shellType
:
ShellType
Returns
string
validate
Shell
Environment
validateShellEnvironment
(
shellType
:
ShellType
)
:
Promise
<
boolean
>
Parameters
shellType
:
ShellType
Returns
Promise
<
boolean
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
format
Completions
generate
Completions
get
Bootstrap
Script
get
Default
Config
Path
validate
Shell
Environment
@flowscripter/dynamic-cli-framework
Loading...
Interface for a service providing shell auto-completion support.