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

Package detail

@types/react-native-fs

itinance11.9kMITdeprecated2.13.0

This is a stub types definition. react-native-fs provides its own type definitions, so you do not need this installed.

Stub TypeScript definitions entry for react-native-fs, which provides its own types definitions

readme

changelog

Changelog

Changes for v2.20

  • 1037 Invalidate upload session

Changes vor v2.19

  • 1048 fix: use correct type for stat size #1048

  • 1063 RNFSManager:readDir iOS crash fix #1063

  • 1036 fix: addListener and removeListeners methods wass added to pass warning with Native Event Emitter #1036

  • RNFSManager iOS crash in readDir
  • fix: use correct type for stat size
  • make react-native-windows peer dependency optional #1016

Changes for v2.17

  • 938 Manually flush & invalidate session upon completion

  • 954 Switch to using channels for byte copying.

  • 962 Size limit with copyAssetsVideoIOS

  • 963 Add basic support for Android content URIs in stat

  • 972 Manually flush & invalidate completed session

  • 974 Add content for copyAssetsFileIOS method

  • 975 Fix copyAssetsFileIOS's image resizing option to resize to exact width and height

  • 985 README.md: clarify usage of readFileRes

  • 986 macOS support

Changes for v2.16

  • 797 Added path to the Android download folder

  • 842 Fixes #811 Concurrent downloads send progress updates to all progress callbacks

  • 783 Import RCTImageLoaderProtocol instead of RCTImageLoader to fix iOS build on RN>0.60

Changes for v2.15

  • 717 bugfix #443: Add option progressInterval for downloadFile

  • 759 Fix for issue #749: RNFS.uploadFiles upload raw not multipart

  • 728 Correctly read binaryStreamOnly param

  • 752 Fix Xcode and Java deprecation warnings

  • 779 Add conditional comments around methods not supported in Mac Catalyst

  • 736 Added support for ph:// uris to copyAssetsFileIOS

Changes for v2.14

  • 718 Add tvOS deployment target to podspec

  • 710 Added existsRes function to Android

  • 702 Fix: S3 pre signed uploads or similar binary stream uploads writing corrupt files

  • 695 Added .Net46 side of windows support

  • 691 Add androidx suppport

  • 669 Changed "size" from Int to Double

  • 660 add a custom error for cancelled downloadFile Requests

Changes for v2.13

  • 544 [Android] Add scanFile method

  • 597 [Android] Perform copyFile in background thread to prevent UI blocking

  • 587 [Windows] Fixed implementation for Windows

  • 585 [Android] Fix EISDIR on stat directory

  • 583 [Android] fix Android downloadFile overflow contentLength and bytesWritten

Changes for v2.12

  • 601 [iOS] Another fix for copyAssetsVideoIOS

  • 599 [iOS] Fix for copyAssetsVideoIOS regarding iCloud-Files

  • 564 [Android] Upgrade to Gradle 3 (BREAKING compatiblity for < RN 0.57)

  • 571 [Android] Fix issue #566 android progress callback not sync and handle uppercase file extension mimetype

Changes for v2.11

  • Prepared for RN 0.56 thanx to #535 by rmevans9
  • 503 make sure to return the original file uri if content:// scheme is not used

  • 510 Fixes an IndexOutOfBounds while uploading files in Android

  • 515 Add cacheable option to downloadFile on iOScompletion callback

  • 516 [iOS] Ensure _bytesWritten is correct in download

  • 519 updated compilesdkversion and buildtoolsversion

  • 535 Make this work with RN56

  • 558 [Android] fixed missing parameter in movefile and writefile

  • 557 [Android] copyFile: fix missing parameter on Android

  • 564 [Android] Replace deprecated 'compile' gradle configuration with 'implementation

Changes for v2.10

  • UploadFiles is now also available for Android #486 by hank121314
  • Fixed a memory leak that caused after running many simultaneous upload jobs on iOS #502 by Ignigena
  • Android: Resolve filepath for content URI 480 by andtos90
  • (Android only) Add ExternalCachesDirectoryPath 490 by superandrew213

Changes for v2.9

  • (iOS only) Resumable downloads and better background downloads handling #335 by ptelad
  • (Android only) getAllExternalFilesDirs() added by ngrj
  • Content URI support #395 by krzysztof-miemiec
  • Fixed Cocoapods-Installation

Changes for v2.8

  • Fix for #346: compressed file assets are detected as directories thx to jacargentina
  • added support for Video-Assets on iOS (copyAssetsVideoIOS) and setReadable() on Android by itinance
  • Added react-native-windows support for UWP #337 thx to rozele
  • Expose the iOS discretionary flag on downloadFile #360 thx to jamesreggio

Changes for v2.5

Changes for v2.4

Changes for v2.3

  • React-Native 0.40 is minimum required for compiling on iOS (otherwise install an older release, see below)
  • Access to iOS-based "assets-library" is now supported with copyAssetsFileIOS
  • readDir will return now creation- and modification-time of files as with stat() (thanks @Ignigena)
  • optional connectionTimeout and readTimeout-Settings on downloadFile for Android (thanks @drunksaint)

Breaking change in v2.0

  • Removed attributes from writeFile and appendFile for iOS / Android consistency
  • downloadFile takes options object rather than parameters
  • stopDownload will cause the rejection of promise returned by downloadFile
  • uploadFiles promise result response property is now body
  • A boolean is no longer returned from any method except exists
  • downloadFile and uploadFiles return an object of the form { jobId: number, promise: Promise }
  • mkdir takes optional 2nd parameter options for iOS users to set the NSURLIsExcludedFromBackupKey attribute