Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/node-core-library > IPathFormatFileLocationOptions

IPathFormatFileLocationOptions interface

Options for Path.formatFileLocation().

Signature:

export interface IPathFormatFileLocationOptions 

Properties

PropertyModifiersTypeDescription
baseFolder?string(Optional) The base path to use when converting pathToFormat to a relative path. If not specified, pathToFormat will be used as-is.
column?number(Optional) The optional column number. If not specified, the column number will not be included in the formatted string.
formatFileLocationStyleThe style of file location formatting to use.
line?number(Optional) The optional line number. If not specified, the line number will not be included in the formatted string.
messagestringThe message related to the file location.
pathToFormatstringThe path that will be used to specify the file location.