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

return {
  summary = 'Write to a file.',
  description = 'Write to a file.',
  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 = {
    bytes = {
      type = 'number',
      description = 'The number of bytes written.'
    }
  },
  variants = {
    {
      arguments = { 'filename', 'content' },
      returns = { 'bytes' }
    },
    {
      arguments = { 'filename', 'blob' },
      returns = { 'bytes' }
    }
  },
  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.
  ]],
  related = {
    'lovr.filesystem.append',
    'lovr.filesystem.read'
  }
}