birdofpreyru / react-native-fs

File system access for React Native
https://dr.pogodin.studio/docs/react-native-file-system
Other
121 stars 8 forks source link

Type interface differences from react-native-fs undocumented #36

Closed angusryer closed 2 months ago

angusryer commented 2 months ago

Hi! Thanks for continuing to maintain this lib!

During a migration to your library (due to the new-ish Apple Privacy requirements), I noticed that the ReadDirItem type from itinance/react-native-fs is not present in this lib. It seems to have been changed to ReadDirResItemT.

So the statement in the readme, aside from the word "presumably", is not totally correct:

v2.22.0 of this library is, presumably, a drop-in replacement for the latest (v2.20.0) release of the original, upstream react-native-fs (beside the need to upgrade host project to the lates RN v0.73). It has matching functionality and API, with just a handfull of internal fixes, and a few additions.

I suppose it should be documented (along with other changes) for those migrating over. Not sure if any other interfaces have also changed.

birdofpreyru commented 2 months ago

Yes, I did append T to all type names. Sorry for not mentioning it in the README section you pointed to. I'll add it later.