Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

universal-file

rax-publisher22BSD-3-Clause1.1.2TypeScript support: included

--- title: file ---

Rax

readme


title: file

universal-file

npm

File operations.

Support

browser miniApp wechatMiniprogram bytedanceMicroApp

Install

$ npm install universal-file --save

Methods

getInfo(options)

Get file information.

Support

miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
filePath String | √ The file path miniApp wechatMiniprogram bytedanceMicroApp
digestAlgorithm String md5 x The algorithm to calculate the file summary can be md5, sha1 miniApp wechatMiniprogram bytedanceMicroApp

getSavedInfo(options)

Gets saved file information.

Support

miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
filePath String | √ The file path miniApp wechatMiniprogram bytedanceMicroApp

getSavedList(options)

Gets all saved file information.

Support

miniApp wechatMiniprogram bytedanceMicroApp

openDocument(options)

Open a file preview on the new page.

Support

miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
filePath String | √ The file path miniApp wechatMiniprogram bytedanceMicroApp
fileType String | x The file Type miniApp wechatMiniprogram bytedanceMicroApp

removeSaved(options)

Delete a saved file.

Support

miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
filePath String | √ The file path miniApp wechatMiniprogram bytedanceMicroApp

save(options)

Save the file locally.

Support

miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
filePath String | √ The file path miniApp wechatMiniprogram bytedanceMicroApp

upload(options)

Upload local resources to the developer server.

Support

browser miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
url String | √ Developer server address browser miniApp wechatMiniprogram bytedanceMicroApp
filePath `String File Object` | √ The path to upload the file resource. In web browser, it can be either base64 string or a File object. browser miniApp wechatMiniprogram bytedanceMicroApp
fileName String | √ File name, that is, the corresponding key, the developer in the server side through this key can get the binary content of the file. browser miniApp wechatMiniprogram bytedanceMicroApp
fileType String | √ File type supports image, video, audio (image/video/audio). Not required in browser. miniApp wechatMiniprogram bytedanceMicroApp
header Object | x The HTTP request Header browser miniApp wechatMiniprogram bytedanceMicroApp
formData Object | x Additional form data in the HTTP request browser miniApp wechatMiniprogram bytedanceMicroApp

download(options)

Download file resources locally.

Support

miniApp wechatMiniprogram bytedanceMicroApp

Parameters

Property Type Default Required Description Support
url String | √ Download file address miniApp wechatMiniprogram bytedanceMicroApp
header Object | x The HTTP request Header miniApp wechatMiniprogram bytedanceMicroApp

Example

import File from 'universal-file';

// Get file information.
File.getInfo({
  filePath: 'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
  digestAlgorithm: 'sha1',
  success: (res)=>{
    console.log(JSON.stringify(res))
  }
});

// You need to save the address to be able to use File.getsavedinfo
File.getSavedInfo({
  filePath: '**filePath**',
  success: (res) => {
    console.log(res.size);
    console.log(res.createTime);
  }
});

File.getSavedList({
  success:(res) => {
    console.log(JSON.stringfy(res));
  }
});

File.openDocument({
  filePath: '**filePath**',
  fileType: 'pdf',
  success: (res) => {
    console.log('open document success');
  };
});

File.removeSaved({
  filePath: '**filePath**',
  success:(res) => {
    console.log('remove success');
  }
});

File.save({
  filePath: '**filePath**',
  success:(res) => {
    console.log('save success');
  }
});

File.upload({
  url: 'http://httpbin.org/post',
  fileType: 'image',
  fileName: 'file',
  filePath: '**filePath**',
  success: res => {
    console.log('upload success');
  },
  fail: res => {
    console.log('upload succefailss');
  },
});

File.download({
  url: 'http://img.alicdn.com/tfs/TB1x669SXXXXXbdaFXXXXXXXXXX-520-280.jpg',
  success: res => {
    console.log(res.filePath);
  },
  fail: res => {
    console.log(res);
  },
});