文件存储 file

接口声明

{ "name": "system.file" }

导入模块

import file from '@system.file' 或 const file = require('@system.file')

接口定义

file.move(OBJECT)

将源文件移动到指定位置，接口中使用的 URI 描述请参考文件组织

参数：

fail 返回错误代码：

示例：

file.move({
  srcUri: 'internal://cache/path/to/file',
  dstUri: 'internal://files/path/to/file',
  success: function(uri) {
    console.log(`move success: ${uri}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.copy(OBJECT)

将源文件复制一份并存储到指定位置，接口中使用的 URI 描述请参考文件组织

参数：

fail 返回错误代码：

示例：

file.copy({
  srcUri: 'internal://cache/path/to/file',
  dstUri: 'internal://files/path/to/file',
  success: function(uri) {
    console.log(`copy success: ${uri}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.list(OBJECT)

获取指定目录下的文件列表，接口中使用的 URI 描述请参考文件组织

参数：

success 返回值：

每个文件的元信息：

fail 返回错误代码：

示例：

file.list({
  uri: 'internal://files/movies/',
  success: function(data) {
    console.log(data.fileList)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.get(OBJECT)

获取本地文件的文件信息，接口中使用的 URI 描述请参考文件组织

参数：

success 返回值：

fail 返回错误代码：

示例：

file.get({
  uri: 'internal://files/path/to/file',
  success: function(data) {
    console.log(data.uri)
    console.log(data.length)
    console.log(data.lastModifiedTime)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.delete(OBJECT)

删除本地存储的文件，接口中使用的 URI 描述请参考文件组织

参数：

fail 返回错误代码：

示例：

file.delete({
  uri: 'internal://files/path/to/file',
  success: function(data) {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.writeText(OBJECT)1010+

写文本到文件

参数：

fail 返回错误代码：

示例：

file.writeText({
  uri: 'internal://files/work/demo.txt',
  text: 'test',
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.writeArrayBuffer(OBJECT)1010+

写 Buffer 到文件

参数：

fail 返回错误代码：

示例：

file.writeArrayBuffer({
  uri: 'internal://files/work/demo',
  buffer: buffer,
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.readText(OBJECT)1010+

从文件中读取文本

参数：

success 返回值：

fail 返回错误代码：

示例：

file.readText({
  uri: 'internal://files/work/demo.txt',
  success: function(data) {
    console.log('text: ' + data.text)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.readArrayBuffer(OBJECT)1010+

从文件中读取 Buffer

参数：

success 返回值：

fail 返回错误代码：

示例：

file.readArrayBuffer({
  uri: 'internal://files/work/demo',
  position: 100,
  length: 100,
  success: function(data) {
    console.log('buffer.length: ' + data.buffer.length)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.access(OBJECT)1060+

判断文件或目录是否存在

参数：

fail 返回错误代码：

示例：

file.access({
  uri: 'internal://files/test',
  success: function(data) {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.mkdir(OBJECT)1060+

创建目录

参数：

fail 返回错误代码：

示例：

file.mkdir({
  uri: 'internal://files/dir/',
  success: function(data) {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.rmdir(OBJECT)1060+

删除目录

参数：

fail 返回错误代码：

示例：

file.rmdir({
  uri: 'internal://files/dir/',
  success: function(data) {
    console.log(`handling success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

后台运行限制

无限制。
后台运行详细用法参见后台运行 脚本。