Interface RenameOptions

Options for renaming a node.

interface RenameOptions {
    renameInComments?: boolean;
    renameInStrings?: boolean;
    usePrefixAndSuffixText?: boolean;
}

Properties

renameInComments?: boolean

Whether comments referencing this node should be renamed.

False by default.

renameInStrings?: boolean

Whether strings referencing this node should be renamed.

False by default.

usePrefixAndSuffixText?: boolean

Whether to enable renaming shorthand property assignments, binding elements, and import & export specifiers without changing behaviour.

Defaults to the usePrefixAndSuffixTextForRename manipulation setting. This setting is only available when using TypeScript 3.4+.