{"bugs":{"url":"https://github.com/raxjs/universal-api/issues"},"dist":{"shasum":"55750c4f1179c6117b21b255554e415b1dfcae1d","tarball":"https://registry.npmjs.org/@uni/file/-/file-1.0.0-beta1.tgz","fileCount":25,"integrity":"sha512-WoN3VHNkLBDxyMVK9MNydhAPjgiyrssbJjw2n52tc6Wd/LQqxxBYL+7fqd7XGXKDPIbc7vqIARGQd38Lv0sKJA==","signatures":[{"sig":"MEUCIQDF7pouoU9/Ghurnjcj3fWU0oIZ+ZHG6ehj2ThMplQ3GAIgQWQeMGd0ffWUZhDMc/rA29aiU7dWJbZ10RBB3BPpzwg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":391141,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgOO7aCRA9TVsSAnZWagAA+gIQAJs5uS7coFNiVl5gh7P7\n3gwPVJr/dupk/jG1wzpIBuqfcOji0tc1icjxHSULvFBKETto8A7U9Fs2BwMI\nS0RrPx+IhW6yqcBRZDuzEwDC6isMx620W5eX7oP97OYUJomF7rUXjtm34a9u\nuE7bbIQNxQlKl6fTI67Sc0G1Gw3bn4p7/yaz9rXFJTgxa2eO/iSNEqwxJqzZ\njHeJdLXaBlDIyoHHLtX4wJvsbxgga0JQPOrHwV5Sla5EEn+xgoneKXgNFpYP\nRwIMguj13yNaGZG4/OMK26ZaKOEPAvgM5pmJtKUzKm+e1yBqCg8RMrCWBxPJ\nnezhBYXYQKRpUjoYqEBiBpxREsbec82WTxxcx9EbHiUMfwCr68Jjjpyh7CAH\nYYtzfTPuCr1G305173fxFAXEkTeBT7ZqpcgfrEkgbUovGwJpiNXSyUj7i2DC\nBhWiynl4DKY8u+4VFvKCGWUeiDAchUZIvG5R3VhgqnBwn6YBGHUYquiLrZIs\nL3ZBgwq7bUrUG9hvoNS9ULX/+ZyO6f0DS/sy3ttvuMgeArA/sIKeUGNq7i4M\nWe9GH553HFoBIj26O8HXUcNR7kN/agQ0fima/hCbSYj0iRYCgeBm4H95CyPq\n8Vkrdp2aV88amEOD/CR8bFqOb5j7poP9Clge6VnlrWClwjGkPP8EUNMm5Dgd\n0Qwy\r\n=++Sg\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","name":"@uni/file","unpkg":"index.umd.js","author":{"name":"rax"},"module":"index.es.js","readme":"# file \n[](https://www.npmjs.com/package/@uni/file)\n\nFile operations.\n\n## Support\n![\"browser\"](\"https://gw.alicdn.com/tfs/TB1uYFobGSs3KVjSZPiXXcsiVXa-200-200.svg\")
![\"miniApp\"](\"https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg\")
![\"wechatMiniprogram\"](\"https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg\")
![\"bytedanceMicroApp\"](\"https://gw.alicdn.com/tfs/TB1jFtVzO_1gK0jSZFqXXcpaXXa-200-200.svg\")
\n\n## Install\n\n```bash\n$ npm install @uni/file --save\n```\n\n## Methods\n\n### `getInfo(options)`\n\nGet file information.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| --------------- | -------- | ------- | -------- | ------------------------------------------------------------ | --------------------------------------- |\n| filePath | `String` | | √ | The file path | |\n| digestAlgorithm | `String` | md5 | x | The algorithm to calculate the file summary can be md5, sha1 | |\n\n\n### `getSavedInfo(options)`\n\nGets saved file information.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| -------- | -------- | ------- | -------- | ------------- | --------------------------------------- |\n| filePath | `String` | | √ | The file path | |\n\n### `getSavedList(options)`\n\nGets all saved file information.\n\n#### Support\n \n\n### `openDocument(options)`\n\nOpen a file preview on the new page.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| -------- | -------- | ------- | -------- | ------------- | --------------------------------------- |\n| filePath | `String` | | √ | The file path | |\n| fileType | `String` | | x | The file Type | |\n\n### `removeSaved(options)`\n\nDelete a saved file.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| -------- | -------- | ------- | -------- | ------------- | --------------------------------------- |\n| filePath | `String` | | √ | The file path | |\n\n### `save(options)`\n\nSave the file locally.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| -------- | -------- | ------- | -------- | ------------- | --------------------------------------- |\n| filePath | `String` | | √ | The file path | |\n\n### `upload(options)`\n\nUpload local resources to the developer server.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| -------- | -------- | ------- | -------- | ------------------------------------ | --------------------------------------- |\n| url | `String` | | √ | Developer server address | |\n| filePath | `String | File Object` | | √ | The path to upload the file resource. In web browser, it can be ei\bther base64 string or a File object. | |\n| 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. | |\n| fileType | `String` | | √ | File type supports image, video, audio (image/video/audio). Not required in browser. | |\n| header | `Object` | | x | The HTTP request Header | |\n| formData | `Object` | | x | Additional form data in the HTTP request | |\n\n\n### `download(options)`\n\nDownload file resources locally.\n\n#### Support\n \n\n#### Parameters\n| Property | Type | Default | Required | Description | Support |\n| -------- | -------- | ------- | -------- | ----------------------- | --------------------------------------- |\n| url | `String` | | √ | Download file address | |\n| header | `Object` | | x | The HTTP request Header | |\n\n## Example\n\n```js\nimport File from '@uni/file';\n\n// Get file information.\nFile.getInfo({\n filePath: 'https://resource/apml953bb093ebd2834530196f50a4413a87.video',\n digestAlgorithm: 'sha1',\n success: (res)=>{\n console.log(JSON.stringify(res))\n }\n});\n\n// You need to save the address to be able to use File.getsavedinfo\nFile.getSavedInfo({\n filePath: '**filePath**',\n success: (res) => {\n console.log(res.size);\n console.log(res.createTime);\n }\n});\n\nFile.getSavedList({\n success:(res) => {\n console.log(JSON.stringfy(res));\n }\n});\n\nFile.openDocument({\n filePath: '**filePath**',\n fileType: 'pdf',\n success: (res) => {\n console.log('open document success');\n };\n});\n\nFile.removeSaved({\n filePath: '**filePath**',\n success:(res) => {\n console.log('remove success');\n }\n});\n\nFile.save({\n filePath: '**filePath**',\n success:(res) => {\n console.log('save success');\n }\n});\n\nFile.upload({\n url: 'http://httpbin.org/post',\n fileType: 'image',\n fileName: 'file',\n filePath: '**filePath**',\n success: res => {\n console.log('upload success');\n },\n fail: res => {\n console.log('upload succefailss');\n },\n});\n\nFile.download({\n url: 'http://img.alicdn.com/tfs/TB1x669SXXXXXbdaFXXXXXXXXXX-520-280.jpg',\n success: res => {\n console.log(res.filePath);\n },\n fail: res => {\n console.log(res);\n },\n});\n\n```\n\n","license":"BSD-3-Clause","typings":"types/index.d.ts","_npmUser":{"name":"bunko","email":"2leg@immaster.cn"},"homepage":"https://github.com/raxjs/universal-api#readme","repository":{"url":"git+ssh://git@github.com/raxjs/universal-api.git","type":"git"},"_npmVersion":"6.14.5","description":"[](https://www.npmjs.com/package/@uni/file)","directories":{},"maintainers":[{"name":"bunko","email":"2leg@immaster.cn"}],"_nodeVersion":"14.4.0","dependencies":{"@babel/runtime-corejs3":"^7.11.0"},"_hasShrinkwrap":false,"readmeFilename":"README.en-US.md","peerDependencies":{"@uni/env":"^1.0.0-beta"},"_npmOperationalInternal":{"tmp":"tmp/file_1.0.0-beta1_1614343898083_0.6991868198830082","host":"s3://npm-registry-packages"},"_id":"@uni/file@1.0.0-beta1","version":"1.0.0-beta1"}