dots.typescript.server.protocol.completion-entry

Liking cljdoc? Tell your friends :D

ClojureScript only.

An item found in a completion response.

An item found in a completion response.

raw docstring

data^cljs

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

Returns: unknown

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.

**Returns:** `unknown`

source raw docstring

filter-text^cljs

(filter-text completion-entry)

A string that should be used when filtering a set of completion items.

Returns: string | undefined

A string that should be used when filtering a set of
completion items.

**Returns:** `string | undefined`

source raw docstring

from-unchecked-file^cljs

(from-unchecked-file completion-entry)

If true, this completion was generated from traversing the name table of an unchecked JS file, and therefore may not be accurate.

Returns: true | undefined

If true, this completion was generated from traversing the name table of an unchecked JS file,
and therefore may not be accurate.

**Returns:** `true | undefined`

source raw docstring

has-action^cljs

(has-action completion-entry)

Indicates whether commiting this completion entry will require additional code actions to be made to avoid errors. The CompletionEntryDetails will have these actions.

Returns: true | undefined

Indicates whether commiting this completion entry will require additional code actions to be
made to avoid errors. The CompletionEntryDetails will have these actions.

**Returns:** `true | undefined`

source raw docstring

import-statement-completion^cljs

(import-statement-completion completion-entry)

If true, this completion was an auto-import-style completion of an import statement (i.e., the module specifier was inserted along with the imported identifier). Used for telemetry reporting.

Returns: true | undefined

If true, this completion was an auto-import-style completion of an import statement (i.e., the
module specifier was inserted along with the imported identifier). Used for telemetry reporting.

**Returns:** `true | undefined`

source raw docstring

insert-text^cljs

(insert-text completion-entry)

Text to insert instead of name. This is used to support bracketed completions; If name might be "a-b" but insertText would be ["a-b"], coupled with replacementSpan to replace a dotted access with a bracket access.

Returns: string | undefined

Text to insert instead of `name`.
This is used to support bracketed completions; If `name` might be "a-b" but `insertText` would be `["a-b"]`,
coupled with `replacementSpan` to replace a dotted access with a bracket access.

**Returns:** `string | undefined`

source raw docstring

kind^cljs

(kind completion-entry)

The symbol's kind (such as 'className' or 'parameterName').

Returns: ScriptElementKind

The symbol's kind (such as 'className' or 'parameterName').

**Returns:** `ScriptElementKind`

source raw docstring

kind-modifiers^cljs

(kind-modifiers completion-entry)

Optional modifiers for the kind (such as 'public').

Returns: string | undefined

Optional modifiers for the kind (such as 'public').

**Returns:** `string | undefined`

source raw docstring

label-details^cljs

(label-details completion-entry)

Additional details for the label.

Returns: CompletionEntryLabelDetails | undefined

Additional details for the label.

**Returns:** `CompletionEntryLabelDetails | undefined`

source raw docstring

name^cljs

(name completion-entry)

The symbol's name.

Returns: string

The symbol's name.

**Returns:** `string`

source raw docstring

package-json-import^cljs

(package-json-import completion-entry)

If true, this completion was for an auto-import of a module not yet in the program, but listed in the project package.json. Used for telemetry reporting.

Returns: true | undefined

If true, this completion was for an auto-import of a module not yet in the program, but listed
in the project package.json. Used for telemetry reporting.

**Returns:** `true | undefined`

source raw docstring

recommended^cljs

(recommended completion-entry)

If true, this completion should be highlighted as recommended. There will only be one of these. This will be set when we know the user should write an expression with a certain type and that type is an enum or constructable class. Then either that enum/class or a namespace containing it will be the recommended symbol.

Returns: true | undefined

If true, this completion should be highlighted as recommended. There will only be one of these.
This will be set when we know the user should write an expression with a certain type and that type is an enum or constructable class.
Then either that enum/class or a namespace containing it will be the recommended symbol.

**Returns:** `true | undefined`

source raw docstring

replacement-span^cljs

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

source raw 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.

source raw docstring

set-filter-text!^cljs

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

A string that should be used when filtering a set of completion items.

A string that should be used when filtering a set of
completion items.

source raw docstring

set-has-action!^cljs

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

Indicates whether commiting this completion entry will require additional code actions to be made to avoid errors. The CompletionEntryDetails will have these actions.

Indicates whether commiting this completion entry will require additional code actions to be
made to avoid errors. The CompletionEntryDetails will have these actions.

source raw docstring

set-insert-text!^cljs

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

Text to insert instead of `name`.
This is used to support bracketed completions; If `name` might be "a-b" but `insertText` would be `["a-b"]`,
coupled with `replacementSpan` to replace a dotted access with a bracket access.

source raw docstring

set-is-from-unchecked-file!^cljs

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

If true, this completion was generated from traversing the name table of an unchecked JS file, and therefore may not be accurate.

If true, this completion was generated from traversing the name table of an unchecked JS file,
and therefore may not be accurate.

source raw docstring

set-is-import-statement-completion!^cljs

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

If true, this completion was an auto-import-style completion of an import statement (i.e., the module specifier was inserted along with the imported identifier). Used for telemetry reporting.

If true, this completion was an auto-import-style completion of an import statement (i.e., the
module specifier was inserted along with the imported identifier). Used for telemetry reporting.

source raw docstring

set-is-package-json-import!^cljs

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

If true, this completion was for an auto-import of a module not yet in the program, but listed in the project package.json. Used for telemetry reporting.

If true, this completion was for an auto-import of a module not yet in the program, but listed
in the project package.json. Used for telemetry reporting.

source raw docstring

set-is-recommended!^cljs

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

If true, this completion should be highlighted as recommended. There will only be one of these.
This will be set when we know the user should write an expression with a certain type and that type is an enum or constructable class.
Then either that enum/class or a namespace containing it will be the recommended symbol.

source raw docstring

set-is-snippet!^cljs

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

insertText should be interpreted as a snippet if true.

`insertText` should be interpreted as a snippet if true.

source raw docstring

set-kind!^cljs

(set-kind! completion-entry value)

The symbol's kind (such as 'className' or 'parameterName').

The symbol's kind (such as 'className' or 'parameterName').

source raw docstring

set-kind-modifiers!^cljs

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

Optional modifiers for the kind (such as 'public').

Optional modifiers for the kind (such as 'public').

source raw docstring

set-label-details!^cljs

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

Additional details for the label.

Additional details for the label.

source raw docstring

set-name!^cljs

(set-name! completion-entry value)

The symbol's name.

The symbol's name.

source raw docstring

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.

source raw docstring

set-sort-text!^cljs

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

A string that is used for comparing completion items so that they can be ordered. This is often the same as the name but may be different in certain circumstances.

A string that is used for comparing completion items so that they can be ordered.  This
is often the same as the name but may be different in certain circumstances.

source raw docstring

set-source!^cljs

(set-source! completion-entry value)

Identifier (not necessarily human-readable) identifying where this completion came from.

Identifier (not necessarily human-readable) identifying where this completion came from.

source raw docstring

set-source-display!^cljs

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

Human-readable description of the source.

Human-readable description of the `source`.

source raw docstring

snippet^cljs

(snippet completion-entry)

insertText should be interpreted as a snippet if true.

Returns: true | undefined

`insertText` should be interpreted as a snippet if true.

**Returns:** `true | undefined`

source raw docstring

sort-text^cljs

(sort-text completion-entry)

A string that is used for comparing completion items so that they can be ordered. This is often the same as the name but may be different in certain circumstances.

Returns: string

A string that is used for comparing completion items so that they can be ordered.  This
is often the same as the name but may be different in certain circumstances.

**Returns:** `string`

source raw docstring

source^cljs

(source completion-entry)

Identifier (not necessarily human-readable) identifying where this completion came from.

Returns: string | undefined

Identifier (not necessarily human-readable) identifying where this completion came from.

**Returns:** `string | undefined`

source raw docstring

source-display^cljs

(source-display completion-entry)

Human-readable description of the source.

Returns: SymbolDisplayPart[] | undefined

Human-readable description of the `source`.

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

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close