Home > @rushstack/node-core-library > IJsonFileStringifyOptions > headerComment

IJsonFileStringifyOptions.headerComment property

If specified, this header will be prepended to the start of the file. The header must consist of lines prefixed by "//" characters.

Signature:

headerComment?: string;

Remarks

When used with IJsonFileSaveOptions.updateExistingFile or JsonFile.updateString(), the header will ONLY be added for a newly created file.