@servicenow/sdk - v4.4.1
    Preparing search index...

    User preferences for refactoring.

    interface UserPreferences {
        allowIncompleteCompletions?: boolean;
        allowRenameOfImportPath?: boolean;
        allowTextChangesInNewFiles?: boolean;
        autoImportFileExcludePatterns?: string[];
        disableLineTextInReferences?: boolean;
        disableSuggestions?: boolean;
        displayPartsForJSDoc?: boolean;
        excludeLibrarySymbolsInNavTo?: boolean;
        generateReturnInDocTemplate?: boolean;
        importModuleSpecifierEnding?: "index" | "auto" | "minimal" | "js";
        importModuleSpecifierPreference?:
            | "shortest"
            | "project-relative"
            | "relative"
            | "non-relative";
        includeAutomaticOptionalChainCompletions?: boolean;
        includeCompletionsForImportStatements?: boolean;
        includeCompletionsForModuleExports?: boolean;
        includeCompletionsWithClassMemberSnippets?: boolean;
        includeCompletionsWithInsertText?: boolean;
        includeCompletionsWithObjectLiteralMethodSnippets?: boolean;
        includeCompletionsWithSnippetText?: boolean;
        includeInlayEnumMemberValueHints?: boolean;
        includeInlayFunctionLikeReturnTypeHints?: boolean;
        includeInlayFunctionParameterTypeHints?: boolean;
        includeInlayParameterNameHints?: "none"
        | "all"
        | "literals";
        includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
        includeInlayPropertyDeclarationTypeHints?: boolean;
        includeInlayVariableTypeHints?: boolean;
        includeInlayVariableTypeHintsWhenTypeMatchesName?: boolean;
        includePackageJsonAutoImports?: "auto" | "on" | "off";
        interactiveInlayHints?: boolean;
        jsxAttributeCompletionStyle?: "none" | "auto" | "braces";
        lazyConfiguredProjectsFromExternalProject?: boolean;
        organizeImportsAccentCollation?: boolean;
        organizeImportsCaseFirst?: false | "upper" | "lower";
        organizeImportsCollation?: "ordinal" | "unicode";
        organizeImportsIgnoreCase?: boolean | "auto";
        organizeImportsLocale?: string;
        organizeImportsNumericCollation?: boolean;
        organizeImportsTypeOrder?: OrganizeImportsTypeOrder;
        preferTypeOnlyAutoImports?: boolean;
        providePrefixAndSuffixTextForRename?: boolean;
        provideRefactorNotApplicableReason?: boolean;
        quotePreference?: "single" | "auto" | "double";
        useLabelDetailsInCompletionEntries?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowIncompleteCompletions?: boolean
    allowRenameOfImportPath?: boolean
    allowTextChangesInNewFiles?: boolean
    autoImportFileExcludePatterns?: string[]
    disableLineTextInReferences?: boolean
    disableSuggestions?: boolean
    displayPartsForJSDoc?: boolean
    excludeLibrarySymbolsInNavTo?: boolean

    Indicates whether to exclude standard library and node_modules file symbols from navTo results.

    generateReturnInDocTemplate?: boolean
    importModuleSpecifierEnding?: "index" | "auto" | "minimal" | "js"

    Determines whether we import foo/index.ts as "foo", "foo/index", or "foo/index.js"

    importModuleSpecifierPreference?:
        | "shortest"
        | "project-relative"
        | "relative"
        | "non-relative"
    includeAutomaticOptionalChainCompletions?: boolean

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

    includeCompletionsForImportStatements?: boolean

    Enables auto-import-style completions on partially-typed import statements. E.g., allows import write| to be completed to import { writeFile } from "fs".

    includeCompletionsForModuleExports?: boolean

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

    includeCompletionsWithClassMemberSnippets?: boolean

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

    includeCompletionsWithInsertText?: boolean

    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"].

    includeCompletionsWithObjectLiteralMethodSnippets?: boolean

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

    includeCompletionsWithSnippetText?: boolean

    Allows completions to be formatted with snippet text, indicated by CompletionItem["isSnippet"].

    includeInlayEnumMemberValueHints?: boolean
    includeInlayFunctionLikeReturnTypeHints?: boolean
    includeInlayFunctionParameterTypeHints?: boolean
    includeInlayParameterNameHints?: "none" | "all" | "literals"
    includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean
    includeInlayPropertyDeclarationTypeHints?: boolean
    includeInlayVariableTypeHints?: boolean
    includeInlayVariableTypeHintsWhenTypeMatchesName?: boolean
    includePackageJsonAutoImports?: "auto" | "on" | "off"
    interactiveInlayHints?: boolean
    jsxAttributeCompletionStyle?: "none" | "auto" | "braces"
    lazyConfiguredProjectsFromExternalProject?: boolean
    organizeImportsAccentCollation?: boolean

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

    This preference is ignored if organizeImportsCollation is not "unicode".

    Default: true

    organizeImportsCaseFirst?: false | "upper" | "lower"

    Indicates whether upper case or lower case should sort first. When false, the default order for the locale specified in organizeImportsCollationLocale is used.

    This preference is ignored if organizeImportsCollation is not "unicode". This preference is also ignored if we are using case-insensitive sorting, which occurs when organizeImportsIgnoreCase is true, or if organizeImportsIgnoreCase is "auto" and the auto-detected case sensitivity is determined to be case-insensitive.

    Default: false

    organizeImportsCollation?: "ordinal" | "unicode"

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

    Default: "ordinal".

    organizeImportsIgnoreCase?: boolean | "auto"

    Indicates whether imports should be organized in a case-insensitive manner.

    organizeImportsLocale?: string

    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 organizeImportsCollation is not "unicode".

    Default: "en"

    organizeImportsNumericCollation?: boolean

    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 organizeImportsCollation is not "unicode".

    Default: false

    organizeImportsTypeOrder?: OrganizeImportsTypeOrder

    Indicates where named type-only imports should sort. "inline" sorts named imports without regard to if the import is type-only.

    Default: last

    preferTypeOnlyAutoImports?: boolean
    providePrefixAndSuffixTextForRename?: boolean
    provideRefactorNotApplicableReason?: boolean
    quotePreference?: "single" | "auto" | "double"
    useLabelDetailsInCompletionEntries?: boolean

    Indicates whether completion entry label details are supported. If not, contents of labelDetails may be included in the CompletionEntry.name property.