(data completion-entry)
A property to be sent back to TS Server in the CompletionDetailsRequest, along with name
,
that allows TS Server to look up the symbol represented by the completion item, disambiguating
items with the same name. Currently only defined for auto-import completions, but the type is
unknown
in the protocol, so it can be changed as needed to support other kinds of completions.
The presence of this property should generally not be used to assume that this completion entry
is an auto-import.
Returns: CompletionEntryData | undefined
A property to be sent back to TS Server in the CompletionDetailsRequest, along with `name`, that allows TS Server to look up the symbol represented by the completion item, disambiguating items with the same name. Currently only defined for auto-import completions, but the type is `unknown` in the protocol, so it can be changed as needed to support other kinds of completions. The presence of this property should generally not be used to assume that this completion entry is an auto-import. **Returns:** `CompletionEntryData | undefined`
(filter-text completion-entry)
Returns: string | undefined
**Returns:** `string | undefined`
(from-unchecked-file completion-entry)
Returns: true | undefined
**Returns:** `true | undefined`
(has-action completion-entry)
Returns: true | undefined
**Returns:** `true | undefined`
(import-statement-completion completion-entry)
Returns: true | undefined
**Returns:** `true | undefined`
(insert-text completion-entry)
Returns: string | undefined
**Returns:** `string | undefined`
(kind completion-entry)
Returns: ScriptElementKind
**Returns:** `ScriptElementKind`
(kind-modifiers completion-entry)
Returns: string | undefined
**Returns:** `string | undefined`
(label-details completion-entry)
Returns: CompletionEntryLabelDetails | undefined
**Returns:** `CompletionEntryLabelDetails | undefined`
(package-json-import completion-entry)
Returns: true | undefined
**Returns:** `true | undefined`
(recommended completion-entry)
Returns: true | undefined
**Returns:** `true | undefined`
(replacement-span completion-entry)
An optional span that indicates the text to be replaced by this completion item. If present, this span should be used instead of the default one. It will be set if the required span differs from the one generated by the default replacement behavior.
Returns: TextSpan | undefined
An optional span that indicates the text to be replaced by this completion item. If present, this span should be used instead of the default one. It will be set if the required span differs from the one generated by the default replacement behavior. **Returns:** `TextSpan | undefined`
(set-data! completion-entry value)
A property to be sent back to TS Server in the CompletionDetailsRequest, along with name
,
that allows TS Server to look up the symbol represented by the completion item, disambiguating
items with the same name. Currently only defined for auto-import completions, but the type is
unknown
in the protocol, so it can be changed as needed to support other kinds of completions.
The presence of this property should generally not be used to assume that this completion entry
is an auto-import.
A property to be sent back to TS Server in the CompletionDetailsRequest, along with `name`, that allows TS Server to look up the symbol represented by the completion item, disambiguating items with the same name. Currently only defined for auto-import completions, but the type is `unknown` in the protocol, so it can be changed as needed to support other kinds of completions. The presence of this property should generally not be used to assume that this completion entry is an auto-import.
(set-is-import-statement-completion! completion-entry value)
(set-replacement-span! completion-entry value)
An optional span that indicates the text to be replaced by this completion item. If present, this span should be used instead of the default one. It will be set if the required span differs from the one generated by the default replacement behavior.
An optional span that indicates the text to be replaced by this completion item. If present, this span should be used instead of the default one. It will be set if the required span differs from the one generated by the default replacement behavior.
(set-symbol! completion-entry value)
For API purposes.
Included for non-string completions only when includeSymbol: true
option is passed to getCompletionsAtPosition
.
For API purposes. Included for non-string completions only when `includeSymbol: true` option is passed to `getCompletionsAtPosition`.
(snippet completion-entry)
Returns: true | undefined
**Returns:** `true | undefined`
(source completion-entry)
Returns: string | undefined
**Returns:** `string | undefined`
(source-display completion-entry)
Returns: SymbolDisplayPart[] | undefined
**Returns:** `SymbolDisplayPart[] | undefined`
(symbol completion-entry)
For API purposes.
Included for non-string completions only when includeSymbol: true
option is passed to getCompletionsAtPosition
.
Returns: Symbol | undefined
For API purposes. Included for non-string completions only when `includeSymbol: true` option is passed to `getCompletionsAtPosition`. **Returns:** `Symbol | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close