(allow-incomplete-completions? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(allow-rename-of-import-path? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(allow-text-changes-in-new-files? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(auto-import-file-exclude-patterns user-preferences)
Returns: string[] | undefined
**Returns:** `string[] | undefined`
(disable-line-text-in-references? user-preferences)
Indicates whether {@link ReferencesResponseItem.lineText } is supported.
Returns: boolean | undefined
Indicates whether {@link ReferencesResponseItem.lineText } is supported. **Returns:** `boolean | undefined`
(disable-suggestions? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(display-parts-for-js-doc? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(exclude-library-symbols-in-nav-to? user-preferences)
Indicates whether to exclude standard library and node_modules file symbols from navTo results.
Returns: boolean | undefined
Indicates whether to exclude standard library and node_modules file symbols from navTo results. **Returns:** `boolean | undefined`
(generate-return-in-doc-template? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(import-module-specifier-ending user-preferences)
Determines whether we import foo/index.ts
as "foo", "foo/index", or "foo/index.js"
Returns: "auto" | "minimal" | "index" | "js" | undefined
Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" **Returns:** `"auto" | "minimal" | "index" | "js" | undefined`
(import-module-specifier-preference user-preferences)
Returns: "shortest" | "project-relative" | "relative" | "non-relative" | undefined
**Returns:** `"shortest" | "project-relative" | "relative" | "non-relative" | undefined`
(include-automatic-optional-chain-completions? user-preferences)
Unless this option is false
, or includeCompletionsWithInsertText
is not enabled,
member completion lists triggered with .
will include entries on potentially-null and potentially-undefined
values, with insertion text to replace preceding .
tokens with ?.
.
Returns: boolean | undefined
Unless this option is `false`, or `includeCompletionsWithInsertText` is not enabled, member completion lists triggered with `.` will include entries on potentially-null and potentially-undefined values, with insertion text to replace preceding `.` tokens with `?.`. **Returns:** `boolean | undefined`
(include-completions-for-import-statements? user-preferences)
Enables auto-import-style completions on partially-typed import statements. E.g., allows
import write|
to be completed to import { writeFile } from "fs"
.
Returns: boolean | undefined
Enables auto-import-style completions on partially-typed import statements. E.g., allows `import write|` to be completed to `import { writeFile } from "fs"`. **Returns:** `boolean | undefined`
(include-completions-for-module-exports? user-preferences)
If enabled, TypeScript will search through all external modules' exports and add them to the completions list.
This affects lone identifier completions but not completions on the right hand side of obj.
.
Returns: boolean | undefined
If enabled, TypeScript will search through all external modules' exports and add them to the completions list. This affects lone identifier completions but not completions on the right hand side of `obj.`. **Returns:** `boolean | undefined`
(include-completions-with-class-member-snippets? user-preferences)
If enabled, completions for class members (e.g. methods and properties) will include
a whole declaration for the member.
E.g., class A { f| }
could be completed to class A { foo(): number {} }
, instead of
class A { foo }
.
Returns: boolean | undefined
If enabled, completions for class members (e.g. methods and properties) will include a whole declaration for the member. E.g., `class A { f| }` could be completed to `class A { foo(): number {} }`, instead of `class A { foo }`. **Returns:** `boolean | undefined`
(include-completions-with-insert-text? user-preferences)
If enabled, the completion list will include completions with invalid identifier names.
For those entries, The insertText
and replacementSpan
properties will be set to change from .x
property access to ["x"]
.
Returns: boolean | undefined
If enabled, the completion list will include completions with invalid identifier names. For those entries, The `insertText` and `replacementSpan` properties will be set to change from `.x` property access to `["x"]`. **Returns:** `boolean | undefined`
(include-completions-with-object-literal-method-snippets? user-preferences)
If enabled, object literal methods will have a method declaration completion entry in addition
to the regular completion entry containing just the method name.
E.g., const objectLiteral: T = { f| }
could be completed to const objectLiteral: T = { foo(): void {} }
,
in addition to const objectLiteral: T = { foo }
.
Returns: boolean | undefined
If enabled, object literal methods will have a method declaration completion entry in addition to the regular completion entry containing just the method name. E.g., `const objectLiteral: T = { f| }` could be completed to `const objectLiteral: T = { foo(): void {} }`, in addition to `const objectLiteral: T = { foo }`. **Returns:** `boolean | undefined`
(include-completions-with-snippet-text? user-preferences)
Allows completions to be formatted with snippet text, indicated by CompletionItem["isSnippet"]
.
Returns: boolean | undefined
Allows completions to be formatted with snippet text, indicated by `CompletionItem["isSnippet"]`. **Returns:** `boolean | undefined`
(include-inlay-enum-member-value-hints? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-inlay-function-like-return-type-hints? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-inlay-function-parameter-type-hints? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-inlay-parameter-name-hints user-preferences)
Returns: "none" | "literals" | "all" | undefined
**Returns:** `"none" | "literals" | "all" | undefined`
(include-inlay-parameter-name-hints-when-argument-matches-name?
user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-inlay-property-declaration-type-hints? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-inlay-variable-type-hints-when-type-matches-name? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-inlay-variable-type-hints? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(include-package-json-auto-imports user-preferences)
Returns: "auto" | "on" | "off" | undefined
**Returns:** `"auto" | "on" | "off" | undefined`
(interactive-inlay-hints? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(jsx-attribute-completion-style user-preferences)
Returns: "auto" | "braces" | "none" | undefined
**Returns:** `"auto" | "braces" | "none" | undefined`
(lazy-configured-projects-from-external-project? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(organize-imports-accent-collation? user-preferences)
Indicates whether accents and other diacritic marks are considered unequal for the purpose of collation. When
true
, characters with accents and other diacritics will be collated in the order defined by the locale specified
in {@link organizeImportsCollationLocale }.
This preference is ignored if {@link organizeImportsCollation } is not "unicode"
.
Default: true
Returns: boolean | undefined
Indicates whether accents and other diacritic marks are considered unequal for the purpose of collation. When `true`, characters with accents and other diacritics will be collated in the order defined by the locale specified in {@link organizeImportsCollationLocale }. This preference is ignored if {@link organizeImportsCollation } is not `"unicode"`. Default: `true` **Returns:** `boolean | undefined`
(organize-imports-case-first user-preferences)
Indicates whether upper case or lower case should sort first. When false
, the default order for the locale
specified in {@link organizeImportsCollationLocale } is used.
This preference is ignored if {@link organizeImportsCollation } is not "unicode"
. This preference is also
ignored if we are using case-insensitive sorting, which occurs when {@link organizeImportsIgnoreCase } is true
,
or if {@link organizeImportsIgnoreCase } is "auto"
and the auto-detected case sensitivity is determined to be
case-insensitive.
Default: false
Returns: false | "upper" | "lower" | undefined
Indicates whether upper case or lower case should sort first. When `false`, the default order for the locale specified in {@link organizeImportsCollationLocale } is used. This preference is ignored if {@link organizeImportsCollation } is not `"unicode"`. This preference is also ignored if we are using case-insensitive sorting, which occurs when {@link organizeImportsIgnoreCase } is `true`, or if {@link organizeImportsIgnoreCase } is `"auto"` and the auto-detected case sensitivity is determined to be case-insensitive. Default: `false` **Returns:** `false | "upper" | "lower" | undefined`
(organize-imports-collation user-preferences)
Indicates whether imports should be organized via an "ordinal" (binary) comparison using the numeric value of their code points, or via "unicode" collation (via the Unicode Collation Algorithm) using rules associated with the locale specified in {@link organizeImportsCollationLocale }.
Default: "ordinal"
.
Returns: "ordinal" | "unicode" | undefined
Indicates whether imports should be organized via an "ordinal" (binary) comparison using the numeric value of their code points, or via "unicode" collation (via the [Unicode Collation Algorithm](https://unicode.org/reports/tr10/#Scope)) using rules associated with the locale specified in {@link organizeImportsCollationLocale }. Default: `"ordinal"`. **Returns:** `"ordinal" | "unicode" | undefined`
(organize-imports-collation-locale user-preferences)
Indicates the locale to use for "unicode" collation. If not specified, the locale "en"
is used as an invariant
for the sake of consistent sorting. Use "auto"
to use the detected UI locale.
This preference is ignored if {@link organizeImportsCollation } is not "unicode"
.
Default: "en"
Returns: string | undefined
Indicates the locale to use for "unicode" collation. If not specified, the locale `"en"` is used as an invariant for the sake of consistent sorting. Use `"auto"` to use the detected UI locale. This preference is ignored if {@link organizeImportsCollation } is not `"unicode"`. Default: `"en"` **Returns:** `string | undefined`
(organize-imports-ignore-case? user-preferences)
Indicates whether imports should be organized in a case-insensitive manner.
Returns: boolean | "auto" | undefined
Indicates whether imports should be organized in a case-insensitive manner. **Returns:** `boolean | "auto" | undefined`
(organize-imports-numeric-collation? user-preferences)
Indicates whether numeric collation should be used for digit sequences in strings. When true
, will collate
strings such that a1z < a2z < a100z
. When false
, will collate strings such that a1z < a100z < a2z
.
This preference is ignored if {@link organizeImportsCollation } is not "unicode"
.
Default: false
Returns: boolean | undefined
Indicates whether numeric collation should be used for digit sequences in strings. When `true`, will collate strings such that `a1z < a2z < a100z`. When `false`, will collate strings such that `a1z < a100z < a2z`. This preference is ignored if {@link organizeImportsCollation } is not `"unicode"`. Default: `false` **Returns:** `boolean | undefined`
(organize-imports-type-order user-preferences)
Indicates where named type-only imports should sort. "inline" sorts named imports without regard to if the import is type-only.
Default: last
Returns: "last" | "first" | "inline" | undefined
Indicates where named type-only imports should sort. "inline" sorts named imports without regard to if the import is type-only. Default: `last` **Returns:** `"last" | "first" | "inline" | undefined`
(provide-prefix-and-suffix-text-for-rename? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(provide-refactor-not-applicable-reason? user-preferences)
Returns: boolean | undefined
**Returns:** `boolean | undefined`
(quote-preference user-preferences)
Returns: "auto" | "double" | "single" | undefined
**Returns:** `"auto" | "double" | "single" | undefined`
(use-label-details-in-completion-entries? user-preferences)
Indicates whether {@link CompletionEntry.labelDetails completion entry label details} are supported.
If not, contents of labelDetails
may be included in the {@link CompletionEntry.name } property.
Returns: boolean | undefined
Indicates whether {@link CompletionEntry.labelDetails completion entry label details} are supported. If not, contents of `labelDetails` may be included in the {@link CompletionEntry.name } property. **Returns:** `boolean | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close