Liking cljdoc? Tell your friends :D

dots.typescript.completion-entry


datacljs

(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`
sourceraw docstring

filter-textcljs

(filter-text completion-entry)

Returns: string | undefined

**Returns:** `string | undefined`
sourceraw docstring

from-unchecked-filecljs

(from-unchecked-file completion-entry)

Returns: true | undefined

**Returns:** `true | undefined`
sourceraw docstring

has-actioncljs

(has-action completion-entry)

Returns: true | undefined

**Returns:** `true | undefined`
sourceraw docstring

import-statement-completioncljs

(import-statement-completion completion-entry)

Returns: true | undefined

**Returns:** `true | undefined`
sourceraw docstring

insert-textcljs

(insert-text completion-entry)

Returns: string | undefined

**Returns:** `string | undefined`
sourceraw docstring

kindcljs

(kind completion-entry)

Returns: ScriptElementKind

**Returns:** `ScriptElementKind`
sourceraw docstring

kind-modifierscljs

(kind-modifiers completion-entry)

Returns: string | undefined

**Returns:** `string | undefined`
sourceraw docstring

label-detailscljs

(label-details completion-entry)

Returns: CompletionEntryLabelDetails | undefined

**Returns:** `CompletionEntryLabelDetails | undefined`
sourceraw docstring

namecljs

(name completion-entry)

Returns: string

**Returns:** `string`
sourceraw docstring

package-json-importcljs

(package-json-import completion-entry)

Returns: true | undefined

**Returns:** `true | undefined`
sourceraw docstring

(recommended completion-entry)

Returns: true | undefined

**Returns:** `true | undefined`
sourceraw docstring

replacement-spancljs

(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`
sourceraw docstring

set-data!cljs

(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.
sourceraw docstring

set-filter-text!cljs

(set-filter-text! completion-entry value)
source

set-has-action!cljs

(set-has-action! completion-entry value)
source

set-insert-text!cljs

(set-insert-text! completion-entry value)
source

set-is-from-unchecked-file!cljs

(set-is-from-unchecked-file! completion-entry value)
source

set-is-import-statement-completion!cljs

(set-is-import-statement-completion! completion-entry value)
source

set-is-package-json-import!cljs

(set-is-package-json-import! completion-entry value)
source

set-is-recommended!cljs

(set-is-recommended! completion-entry value)
source

set-is-snippet!cljs

(set-is-snippet! completion-entry value)
source

set-kind!cljs

(set-kind! completion-entry value)
source

set-kind-modifiers!cljs

(set-kind-modifiers! completion-entry value)
source

set-label-details!cljs

(set-label-details! completion-entry value)
source

set-name!cljs

(set-name! completion-entry value)
source

set-replacement-span!cljs

(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.
sourceraw docstring

set-sort-text!cljs

(set-sort-text! completion-entry value)
source

set-source!cljs

(set-source! completion-entry value)
source

set-source-display!cljs

(set-source-display! completion-entry value)
source

set-symbol!cljs

(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`.
sourceraw docstring

snippetcljs

(snippet completion-entry)

Returns: true | undefined

**Returns:** `true | undefined`
sourceraw docstring

sort-textcljs

(sort-text completion-entry)

Returns: string

**Returns:** `string`
sourceraw docstring

sourcecljs

(source completion-entry)

Returns: string | undefined

**Returns:** `string | undefined`
sourceraw docstring

source-displaycljs

(source-display completion-entry)

Returns: SymbolDisplayPart[] | undefined

**Returns:** `SymbolDisplayPart[] | undefined`
sourceraw docstring

symbolcljs

(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`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close