lovr-docs/api/lovr/filesystem/write.lua

return {
  tag = 'filesystem-files',
  summary = 'Write to a file.',
  description = 'Write to a file in the save directory.',
  arguments = {
    filename = {
      type = 'string',
      description = 'The file to write to.'
    },
    content = {
      type = 'string',
      description = 'A string to write to the file.'
    },
    blob = {
      type = 'Blob',
      description = 'A Blob containing data to write to the file.'
    }
  },
  returns = {
    success = {
      type = 'boolean',
      description = 'Whether the write was successful.'
    }
  },
  variants = {
    {
      arguments = { 'filename', 'content' },
      returns = { 'success' }
    },
    {
      arguments = { 'filename', 'blob' },
      returns = { 'success' }
    }
  },
  notes = [[
    If the file does not exist, it is created.

    If the file already has data in it, it will be replaced with the new content.

    If the path contains subdirectories, all of the parent directories need to exist first or the
    write will fail.  Use `lovr.filesystem.createDirectory` to make sure they're created first.
  ]],
  related = {
    'lovr.filesystem.append',
    'lovr.filesystem.getSaveDirectory',
    'lovr.filesystem.read'
  }
}