Home > @rushstack/node-core-library > IPathFormatFileLocationOptions
IPathFormatFileLocationOptions interface
Options for Path.formatFileLocation().
Signature:
export interface IPathFormatFileLocationOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| 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. | |
| format | FileLocationStyle | The 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. | |
| message | string | The message related to the file location. | |
| pathToFormat | string | The path that will be used to specify the file location. |