mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Summary: Following up from https://github.com/facebook/react-native/issues/47182, as basic caching control is already in place in Android, it can be extended to include the `only-if-cached` option. We check whether the image is in the cache. If it is, we proceed to load it. Otherwise, we do nothing. ## Changelog: [ANDROID] [ADDED] - Image `only-if-cached` cache control option Pull Request resolved: https://github.com/facebook/react-native/pull/47348 Test Plan: In the `rn-tester`, I added a third example for Android where the third image will never be loaded as the cache policy is set to `only-if-cached` and the image has not been loaded before. <details> <summary>Video demonstrating how the `only-if-cached` options behaves</summary> https://github.com/user-attachments/assets/45669e81-5414-4103-8931-138bffa81447 </details> <details> <summary>Error from image not found in cache example</summary> <img width="807" alt="image" src="https://github.com/user-attachments/assets/6b79d811-1809-437c-b2fe-c86d3da7c58d"> </details> Reviewed By: rshest Differential Revision: D65384639 Pulled By: Abbondanzo fbshipit-source-id: f4a72694f45eb3d7097c350f4a4008a0abf0a1ab
77 lines
2.9 KiB
TypeScript
77 lines
2.9 KiB
TypeScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
/*
|
|
* @see https://github.com/facebook/react-native/blob/master/Libraries/Image/ImageSource.js
|
|
*/
|
|
export interface ImageURISource {
|
|
/**
|
|
* `uri` is a string representing the resource identifier for the image, which
|
|
* could be an http address, a local file path, or the name of a static image
|
|
* resource (which should be wrapped in the `require('./path/to/image.png')`
|
|
* function).
|
|
*/
|
|
uri?: string | undefined;
|
|
/**
|
|
* `bundle` is the iOS asset bundle which the image is included in. This
|
|
* will default to [NSBundle mainBundle] if not set.
|
|
* @platform ios
|
|
*/
|
|
bundle?: string | undefined;
|
|
/**
|
|
* `method` is the HTTP Method to use. Defaults to GET if not specified.
|
|
*/
|
|
method?: string | undefined;
|
|
/**
|
|
* `headers` is an object representing the HTTP headers to send along with the
|
|
* request for a remote image.
|
|
*/
|
|
headers?: {[key: string]: string} | undefined;
|
|
/**
|
|
* `cache` determines how the requests handles potentially cached
|
|
* responses.
|
|
*
|
|
* - `default`: Use the native platforms default strategy. `useProtocolCachePolicy` on iOS.
|
|
*
|
|
* - `reload`: The data for the URL will be loaded from the originating source.
|
|
* No existing cache data should be used to satisfy a URL load request.
|
|
*
|
|
* - `force-cache`: The existing cached data will be used to satisfy the request,
|
|
* regardless of its age or expiration date. If there is no existing data in the cache
|
|
* corresponding the request, the data is loaded from the originating source.
|
|
*
|
|
* - `only-if-cached`: The existing cache data will be used to satisfy a request, regardless of
|
|
* its age or expiration date. If there is no existing data in the cache corresponding
|
|
* to a URL load request, no attempt is made to load the data from the originating source,
|
|
* and the load is considered to have failed.
|
|
*
|
|
* @platform ios (for `force-cache`)
|
|
*/
|
|
cache?: 'default' | 'reload' | 'force-cache' | 'only-if-cached' | undefined;
|
|
/**
|
|
* `body` is the HTTP body to send with the request. This must be a valid
|
|
* UTF-8 string, and will be sent exactly as specified, with no
|
|
* additional encoding (e.g. URL-escaping or base64) applied.
|
|
*/
|
|
body?: string | undefined;
|
|
/**
|
|
* `width` and `height` can be specified if known at build time, in which case
|
|
* these will be used to set the default `<Image/>` component dimensions.
|
|
*/
|
|
width?: number | undefined;
|
|
height?: number | undefined;
|
|
/**
|
|
* `scale` is used to indicate the scale factor of the image. Defaults to 1.0 if
|
|
* unspecified, meaning that one image pixel equates to one display point / DIP.
|
|
*/
|
|
scale?: number | undefined;
|
|
}
|
|
|
|
export type ImageRequireSource = number;
|