小程序API开发——文件FileSystemManager参数汇总

创建智能小程序。

FileSystemManager.access

判断文件/目录是否存在

参数

Object object

判断文件/目录是否存在的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
path	string		是	要判断是否存在的文件/目录路径 (本地路径)
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 判断文件/目录是否存在
 */
export function access(params: {
  /** 要判断是否存在的文件/目录路径 (本地路径) */
  path: string;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.mkdir

创建目录，需要文件读写权限

参数

Object object

创建目录，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
dirPath	string		是	创建的目录路径 (本地路径)
recursive	boolean		否	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。 如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录， 以此类推直至创建 a/b/c 目录下的 d 目录。 默认值：false
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 创建目录，需要文件读写权限
 */
export function mkdir(params: {
  /** 创建的目录路径 (本地路径) */
  dirPath: string;
  /**
   * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。
   * 如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，
   * 以此类推直至创建 a/b/c 目录下的 d 目录。
   * 默认值：false
   */
  recursive?: boolean;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.mkdirSync

创建目录同步方法，需要文件读写权限

参数

Object object

创建目录，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
fileId	string		是	taskId
dirPath	string		是	创建的目录路径 (本地路径)
recursive	boolean		否	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。 如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录， 以此类推直至创建 a/b/c 目录下的 d 目录。 默认值：false

函数定义示例

/**
 * 创建目录，需要文件读写权限
 */
export function mkdirSync(params: {
  /** taskId */
  fileId: string;
  /** 创建的目录路径 (本地路径) */
  dirPath: string;
  /**
   * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。
   * 如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，
   * 以此类推直至创建 a/b/c 目录下的 d 目录。
   * 默认值：false
   */
  recursive?: boolean;
}): null;

FileSystemManager.readFile

读取本地文件内容

参数

Object object

读取本地文件内容的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
filePath	string		是	要写入的文件路径 (本地路径)
encoding	string		否	指定读取文件的字符编码。 支持 utf8/ascii/base64。如果不传 encoding，默认 utf8
position	number		否	从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 position, position+length)。有效范围：\[0, fileLength - 1。单位：byte
length	number		否	指定文件的长度，如果不指定，则读到文件末尾。有效范围：1, fileLength。单位：byte
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
data	string	文件内容

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 读取本地文件内容
 */
export function readFile(params: {
  /** 要写入的文件路径 (本地路径) */
  filePath: string;
  /**
   * 指定读取文件的字符编码。
   * 支持 utf8/ascii/base64。如果不传 encoding，默认utf8
   */
  encoding?: string;
  /** 从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte */
  position?: number;
  /** 指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte */
  length?: number;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 文件内容 */
    data: string;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.readFileSync

读取本地文件内容同步方法

参数

Object object

读取本地文件内容的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
filePath	string		是	要写入的文件路径 (本地路径)
encoding	string		否	指定读取文件的字符编码。 支持 utf8/ascii/base64。如果不传 encoding，默认 utf8
position	number		否	从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 position, position+length)。有效范围：\[0, fileLength - 1。单位：byte
length	number		否	指定文件的长度，如果不指定，则读到文件末尾。有效范围：1, fileLength。单位：byte

返回值

属性	类型	说明
data	string	文件内容

函数定义示例

/**
 * 读取本地文件内容
 */
export function readFileSync(params: {
  /** 要写入的文件路径 (本地路径) */
  filePath: string;
  /**
   * 指定读取文件的字符编码。
   * 支持 utf8/ascii/base64。如果不传 encoding，默认utf8
   */
  encoding?: string;
  /** 从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength - 1]。单位：byte */
  position?: number;
  /** 指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte */
  length?: number;
}): {
  /** 文件内容 */
  data: string;
};

FileSystemManager.removeSavedFile

删除已保存的本地缓存文件，需要文件读写权限

参数

Object object

删除已保存的本地缓存文件，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
filePath	string		是	需要删除的文件路径 (本地路径)
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 删除已保存的本地缓存文件，需要文件读写权限
 */
export function removeSavedFile(params: {
  /** 需要删除的文件路径 (本地路径) */
  filePath: string;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.mkdir

创建目录，需要文件读写权限

参数

Object object

删除目录，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
dirPath	string		是	要删除的目录路径 (本地路径)
recursive	boolean		否	是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 默认值：false
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 删除目录，需要文件读写权限
 */
export function rmdir(params: {
  /** 要删除的目录路径 (本地路径) */
  dirPath: string;
  /**
   * 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。
   * 默认值：false
   */
  recursive?: boolean;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.mkdirSync

创建目录同步方法，需要文件读写权限

参数

Object object

删除目录，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
fileId	string		是	taskId
dirPath	string		是	要删除的目录路径 (本地路径)
recursive	boolean		否	是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 默认值：false

函数定义示例

/**
 * 删除目录，需要文件读写权限
 */
export function rmdirSync(params: {
  /** taskId */
  fileId: string;
  /** 要删除的目录路径 (本地路径) */
  dirPath: string;
  /**
   * 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。
   * 默认值：false
   */
  recursive?: boolean;
}): null;

FileSystemManager.saveFile

文件保存的同步方法， 在完成文件保存后调用回调， 需要与 getTempDirectory 配合使用， 目标路径会校验是否包含 getTempDirectory 前缀

参数

Object object

文件保存的同步方法， 在完成文件保存后调用回调， 需要与 getTempDirectory 配合使用， 目标路径会校验是否包含 getTempDirectory 前缀的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
tempFilePath	string		是	临时存储文件路径
filePath	string		是	要存储的文件路径
complete	function		否	接口调用完成的回调函数（成功或失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
savedFilePath	string	【待废弃， 不建议使用】存储后的文件路径

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 文件保存的同步方法， 在完成文件保存后调用回调， 需要与getTempDirectory配合使用， 目标路径会校验是否包含getTempDirectory前缀
 */
export function saveFile(params: {
  /** 临时存储文件路径 */
  tempFilePath: string;
  /** 要存储的文件路径 */
  filePath: string;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 【待废弃， 不建议使用】存储后的文件路径 */
    savedFilePath: string;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.saveFileSync

文件保存的同步方法， 在完成文件保存后调用回调， 需要与 getTempDirectory 配合使用， 目标路径会校验是否包含 getTempDirectory 前缀同步方法

参数

Object object

文件保存的同步方法， 在完成文件保存后调用回调， 需要与 getTempDirectory 配合使用， 目标路径会校验是否包含 getTempDirectory 前缀的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
fileId	string		是	taskId
tempFilePath	string		是	临时存储文件路径
filePath	string		是	要存储的文件路径

返回值

属性	类型	说明
savedFilePath	string	【待废弃， 不建议使用】存储后的文件路径

函数定义示例

/**
 * 文件保存的同步方法， 在完成文件保存后调用回调， 需要与getTempDirectory配合使用， 目标路径会校验是否包含getTempDirectory前缀
 */
export function saveFileSync(params: {
  /** taskId */
  fileId: string;
  /** 临时存储文件路径 */
  tempFilePath: string;
  /** 要存储的文件路径 */
  filePath: string;
}): {
  /** 【待废弃， 不建议使用】存储后的文件路径 */
  savedFilePath: string;
};

FileSystemManager.stat

获取文件 Stats 对象，需要文件读写权限

参数

Object object

获取文件 Stats 对象，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
path	string		是	文件/目录路径 (本地路径)
recursive	boolean		否	是否递归获取目录下的每个文件的 Stats 信息 默认值：false
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
fileStatsList	array	文件列表

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 获取文件Stats对象，需要文件读写权限
 */
export function stat(params: {
  /** 文件/目录路径 (本地路径) */
  path: string;
  /**
   * 是否递归获取目录下的每个文件的 Stats 信息
   * 默认值：false
   */
  recursive?: boolean;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 文件列表 */
    fileStatsList: FileStats[];
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.statSync

获取文件 Stats 对象同步方法，需要文件读写权限

参数

Object object

获取文件 Stats 对象，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
fileId	string		是	taskId
path	string		是	文件/目录路径 (本地路径)
recursive	boolean		否	是否递归获取目录下的每个文件的 Stats 信息 默认值：false

返回值

属性	类型	说明
fileStatsList	array	文件列表

函数定义示例

/**
 * 获取文件Stats对象，需要文件读写权限
 */
export function statSync(params: {
  /** taskId */
  fileId: string;
  /** 文件/目录路径 (本地路径) */
  path: string;
  /**
   * 是否递归获取目录下的每个文件的 Stats 信息
   * 默认值：false
   */
  recursive?: boolean;
}): {
  /** 文件列表 */
  fileStatsList: FileStats[];
};

FileSystemManager.writeFile

写文件，需要文件读写权限

参数

Object object

写文件，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
filePath	string		是	要写入的文件路径 (本地路径)
data	string		是	要写入的文本数据, 根据 encoding 编码
encoding	string		否	指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认 utf8
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 写文件，需要文件读写权限
 */
export function writeFile(params: {
  /** 要写入的文件路径 (本地路径) */
  filePath: string;
  /** 要写入的文本数据, 根据encoding编码 */
  data: string;
  /** 指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认utf8 */
  encoding?: string;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

FileSystemManager.writeFileSync

写文件同步方法，需要文件读写权限

参数

Object object

写文件，需要文件读写权限的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
fileId	string		是	taskId
filePath	string		是	要写入的文件路径 (本地路径)
data	string		是	要写入的文本数据, 根据 encoding 编码
encoding	string		否	指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认 utf8

函数定义示例

/**
 * 写文件，需要文件读写权限
 */
export function writeFileSync(params: {
  /** taskId */
  fileId: string;
  /** 要写入的文件路径 (本地路径) */
  filePath: string;
  /** 要写入的文本数据, 根据encoding编码 */
  data: string;
  /** 指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认utf8 */
  encoding?: string;
}): null;

👉 立即开发。

ty.getFileSystemManager

获取全局唯一的文件管理器。

参数

Object object

获取文件管理器的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

FileSystemManager

文件管理器