status-im/react-native-image-resizer
2
0
Fork 0
mirror of https://github.com/status-im/react-native-image-resizer.git synced 2025-02-05 11:23:21 +00:00
Code Issues Projects Releases Wiki Activity

Add note to README explaining file: prefix (#62)

Browse Source 
Resolves #50.
This commit is contained in:
Kevin Cooper 2017-01-20 13:33:23 -05:00 committed by Florian Rival
parent 37642cf4f3
commit 2680941ae0
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -49,7 +49,9 @@ A basic, sample app is available in [the `example` folder](https://github.com/ba
### `promise createResizedImage(path, maxWidth, maxHeight, compressFormat, quality, rotation = 0, outputPath)`
The promise resolves with a string containing the uri of the new file.
The promise resolves with a string containing the URI of the new file. This URI can be used directly as the `source` of an [`<Image>`](https://facebook.github.io/react-native/docs/image.html) component.
> :warning: On Android, `file:` will be prepended to the returned string. This allows it to be displayed as an image, but it also means you [won't be able to access the file directly](https://github.com/bamlab/react-native-image-resizer/issues/50) when using a utility like `fs`. To do so, you can simply use `rawPath = originalPath.replace('file:', '')` to get the raw path.
Option | Description
------ | -----------