Skip to content

Commit ef001e4

Browse files
committed
chore: Mark PrimaryDirectoryPath & StorageVolumesDirectoryPaths as deprecated
- This library shouldn't care about where the media comes from and the fact that `StorageVolumesDirectoryPaths` might not return everything.
1 parent 872a0db commit ef001e4

4 files changed

Lines changed: 13 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
1010
### ⚡ Changes
1111

1212
- Bumped AndroidX media3 to `1.6.1` from `1.5.1`.
13+
- Mark `PrimaryDirectoryPath` & `StorageVolumesDirectoryPaths` as deprecated.
14+
- This library shouldn't care about where the media comes from and the fact that `StorageVolumesDirectoryPaths` might not return everything.
15+
- Will be removed in `v1.0.0`.
1316

1417
### Other
1518

16-
- Validate that the New Architecture works in example app.
19+
- Validate that the New Architecture works in the example app.
1720
- Required a workaround for CMAKE due to long paths in Windows.
1821

1922
## [0.8.0] - 2025-02-13

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ const base64Artwork = await getArtwork(uri);
4040

4141
## Constants
4242

43+
> [!CAUTION]
44+
> All exported constants relating to directory paths from this library will be deprecated in `v1.0.0`.
45+
4346
### MediaMetadataPublicFields
4447

4548
```ts
@@ -64,15 +67,15 @@ const MusicDirectoryPath: string | null;
6467

6568
Default path to the `Music` folder on device. This is usually `/storage/emulated/0/Music` or `/sdcard/Music` for older devices.
6669

67-
### PrimaryDirectoryPath
70+
### [Deprecated] PrimaryDirectoryPath
6871

6972
```ts
7073
const PrimaryDirectoryPath: string;
7174
```
7275

7376
Path to the primary shared/external storage directory. This is usually `/storage/emulated/0`.
7477

75-
### StorageVolumesDirectoryPaths
78+
### [Deprecated] StorageVolumesDirectoryPaths
7679

7780
```ts
7881
const StorageVolumesDirectoryPaths: string[];

src/NativeMetadataRetriever.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ export interface Spec extends TurboModule {
77
* Path of primary storage volume on device.
88
*
99
* @example `"/storage/emulated/0"`
10+
* @deprecated
1011
*/
1112
PrimaryDirectoryPath: string;
1213
/**
1314
* Array of directory paths for all shared/external storage volumes.
1415
*
1516
* @example `["/storage/emulated/0", "/storage/0A08-1F1A"]`
1617
* @see https://developer.android.com/reference/android/content/Context#getExternalFilesDirs(java.lang.String)
18+
* @deprecated
1719
*/
1820
StorageVolumesDirectoryPaths: string[];
1921
/**

src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ export {
4141
// System paths.
4242
/** @deprecated */
4343
MusicDirectoryPath,
44+
/** @deprecated */
4445
PrimaryDirectoryPath,
46+
/** @deprecated */
4547
StorageVolumesDirectoryPaths,
4648
};

0 commit comments

Comments
 (0)