Table of contents

Using the file system

On this page

Checkly creates a sandboxed directory for each check run. During the run you can use this directory to save or upload artifacts. This directory is destroyed after a check is finished.

Due to this sandbox, certain Node.js variables are adapted to our platform and have values we set for them:

__dirname will have the value of /
__filename will have the value of /script.js

The values these variables correspond to might change in the future. Therefore, we recommend using __dirname, like path.join(__dirname, 'example.png') or relative paths, like ./example.png or just example.png, while using the file system-related operation. You can find an example code snippet below:

Playwright

const path = require('path')
const fs = require('fs')
const playwright = require('playwright')

const browser = await playwright.chromium.launch()
const page = await browser.newPage()
const image = await page.goto('https://picsum.photos/200/300')
const imagePath = path.join(__dirname, 'example.jpg')
const buffer = await image.body()
fs.writeFileSync(imagePath, buffer)
const readFileFromDisk = fs.readFileSync(imagePath)
await browser.close()

Puppeteer

const path = require('path')
const fs = require('fs')
const puppeteer = require('puppeteer')

const browser = await puppeteer.launch()
const page = await browser.newPage()
const image = await page.goto('https://picsum.photos/200/300')
const imagePath = path.join(__dirname, 'example.jpg')
const buffer = await image.buffer()
fs.writeFileSync(imagePath, buffer)
const readFileFromDisk = fs.readFileSync(imagePath)
await browser.close()

You can contribute to this documentation by editing this page on Github