logToFile.js
Area: Diagnostics
Shows the /logging module: LogFile.create(path, LogLevel, append) followed by start(), flush(), and stop(). It demonstrates that the file's level filters records (console.debug is excluded at Info, console.warn after dropping to Error), and that the path must be allowed in the app's Scripting settings. Useful when an example misbehaves and console.log is not enough.
Source: logToFile.js
Example scripts
logToFile.js
logToFile.js
/*
BSD 3-Clause License
Copyright (c) 2026, Canva Pty Ltd.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
'use strict';
const { Application } = require('/application.js');
const { LogFile, LogLevel } = require('/logging.js');
function main(path, append = true) {
// The selected folder must be allowed in the application's Scripting settings.
const outputPath = path || `${Application.userDesktopPath}/affinity-script.log`;
const logFile = LogFile.create(outputPath, LogLevel.Info, append);
logFile.start();
try {
console.debug("Excluded by the file's initial Info level");
console.info("Writing this script's log records to", outputPath);
console.warn("This warning is included");
// This does not wait for records still queued by the sink.
logFile.flush();
logFile.logLevel = LogLevel.Error;
console.warn("Excluded after changing the file level to Error");
console.error("This error is included");
}
finally {
logFile.stop();
}
}
module.exports.main = main;