@georstat/react-native-image-cache/lib/typescript/types.d.ts

React Native image file system caching for iOS and Android

import {
  AccessibilityRole,
  ImageLoadEventData,
  ImageResizeMode,
  ImageSourcePropType,
  ImageStyle,
  ImageURISource,
  NativeSyntheticEvent,
  StyleProp,
} from 'react-native';
import React from 'react';

export interface DownloadOptions {
  headers?: {
    [name: string]: string;
  };
}

export interface ImageState {
  error: boolean;
  imageLoaded: boolean;
  showDefault: boolean;
  uri: string | undefined;
}

export interface ImageProps {
  cacheKey?: string;
  defaultSource?: ImageURISource | number;
  maxAge?: number;
  noCache?: boolean;
  onError: (error: { nativeEvent: { error: Error } }) => void;
  options?: DownloadOptions;
  source: string;
  style?: StyleProp<ImageStyle>;
  thumbnailSource?: string;
}

export interface IProps {
  accessibilityHint?: string;
  accessibilityHintLoadingImage?: string;
  accessibilityHintThumbnail?: string;
  accessibilityLabel?: string;
  accessibilityLabelLoadingImage?: string;
  accessibilityLabelThumbnail?: string;
  accessibilityRole?: AccessibilityRole;
  accessibilityRoleLoadingSource?: AccessibilityRole;
  accessibilityRoleThumbnail?: AccessibilityRole;
  blurRadius?: number;
  cacheKey?: string;
  imageStyle?: StyleProp<ImageStyle>;
  loadingImageComponent?: React.ComponentType;
  loadingImageStyle?: StyleProp<ImageStyle>;
  loadingSource?: ImageSourcePropType;
  maxAge?: number;
  noCache?: boolean;
  onError?: (error: { nativeEvent: { error: Error } }) => void;
  onLoad?: (event: NativeSyntheticEvent<ImageLoadEventData>) => void;
  onLoadEnd?: () => void;
  options?: DownloadOptions;
  resizeMode?: ImageResizeMode;
  source: string;
  sourceAnimationDuration?: number;
  style?: StyleProp<ImageStyle>;
  testID?: string;
  thumbnailAnimationDuration?: number;
  thumbnailSource?: string;
  tintColor?: string;
}

export interface Config {
  baseDir: string;
  blurRadius: number;
  cacheLimit: number;
  getCustomCacheKey?: (source: string) => string;
  maxRetries?: number;
  retryDelay?: number;
  sourceAnimationDuration: number;
  thumbnailAnimationDuration: number;
}