Skip to content

docs: clarify ResourceFetcher class docstring #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
msluszniak merged 2 commits into from
Apr 24, 2026
Merged

docs: clarify ResourceFetcher class docstring #1087

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fd0954
docs: clarify ResourceFetcher class docstring
msluszniak Apr 22, 2026
7915e5e
docs: drop file-level ResourceFetcher docstring
msluszniak Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 8 additions & 32 deletions packages/react-native-executorch/src/utils/ResourceFetcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,3 @@
/**
* Resource Fetcher
*
* Provides an interface for downloading files (via `ResourceFetcher.fetch()`)
*
* Key functionality:
* - Download control: pause, resume, and cancel operations through:
* - Single file: `.pauseFetching()`, `.resumeFetching()`, `.cancelFetching()`
* - Downloaded file management:
* - `.getFilesTotalSize()`, `.listDownloadedFiles()`, `.listDownloadedModels()`, `.deleteResources()`
*
* Remark: The pausing/resuming/canceling works only for fetching remote resources.
*
* Most exported functions accept:
* - Multiple `ResourceSource` arguments, (union type of string, number or object)
*
* Method `.fetch()` takes argument as callback that reports download progress.
* Method`.fetch()` returns array of paths to successfully saved files or null if the download was paused or cancelled (then resume functions can return paths).
*
* Technical Implementation:
* - Maintains a `downloads` Map instance that tracks:
* - Currently downloading resources
* - Paused downloads
* - Successful downloads are automatically removed from the `downloads` Map
* - Uses the `ResourceSourceExtended` interface to enable pause/resume functionality:
* - Wraps user-provided `ResourceSource` elements
* - Implements linked list behavior via the `.next` attribute
* - Automatically processes subsequent downloads when `.next` contains a valid resource
*/

import { ResourceSource } from '../types/common';
import { RnExecutorchError } from '../errors/errorUtils';
import { RnExecutorchErrorCode } from '../errors/ErrorCodes';
Expand Down Expand Up @@ -71,8 +41,14 @@ export interface ResourceFetcherAdapter {
}

/**
* This module provides functions to download and work with downloaded files stored in the application's document directory inside the `react-native-executorch/` directory.
* These utilities can help you manage your storage and clean up the downloaded files when they are no longer needed.
* Static entry point that delegates resource operations to the configured
* `ResourceFetcherAdapter` (registered via `initExecutorch({ resourceFetcher })`).
*
* For storage-management utilities — deleting downloaded models, listing
* downloaded files, getting their total size, and pausing/resuming/cancelling
* downloads — use the adapter implementation directly. See `ExpoResourceFetcher`
* (in `react-native-executorch-expo-resource-fetcher`) or `BareResourceFetcher`
* (in `react-native-executorch-bare-resource-fetcher`).
* @category Utilities - General
*/
export class ResourceFetcher {
Expand Down
Loading