智能小程序 Ray 开发文件 API 合集（二）

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;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

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;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。