Type Aliases

The following type aliases are available globally.

Deprecated

  • Undocumented

    Declaration

    Swift

    public typealias CompletionHandler = ((_ image: KFCrossPlatformImage?, _ error: NSError?, _ cacheType: CacheType, _ imageURL: URL?) -> Void)
  • Undocumented

    Declaration

    Swift

    public typealias ImageDownloaderCompletionHandler = ((_ image: KFCrossPlatformImage?, _ error: NSError?, _ url: URL?, _ originalData: Data?) -> Void)
  • Undocumented

    Declaration

    Swift

    public typealias ImageDownloaderProgressBlock = DownloadProgressBlock
  • Undocumented

    Declaration

    Swift

    public typealias Image = KFCrossPlatformImage
  • Undocumented

    Declaration

    Swift

    public typealias View = KFCrossPlatformView
  • Undocumented

    Declaration

    Swift

    public typealias Color = KFCrossPlatformColor
  • Undocumented

    Declaration

    Swift

    public typealias ImageView = KFCrossPlatformImageView
  • Undocumented

    Declaration

    Swift

    public typealias Button = KFCrossPlatformButton
  • Undocumented

    Declaration

    Swift

    public typealias KFCrossPlatformView = NSView
  • Undocumented

    Declaration

    Swift

    public typealias KFCrossPlatformColor = NSColor
  • Undocumented

    Declaration

    Swift

    public typealias KFCrossPlatformButton = NSButton
  • The downloading progress block type. The parameter value is the receivedSize of current response. The second parameter is the total expected data length from response’s “Content-Length” header. If the expected length is not available, this block will not be called.

    Declaration

    Swift

    public typealias DownloadProgressBlock = ((_ receivedSize: Int64, _ totalSize: Int64) -> Void)
  • The downloading task updated block type. The parameter newTask is the updated new task of image setting process. It is a nil if the image loading does not require an image downloading process. If an image downloading is issued, this value will contain the actual DownloadTask for you to keep and cancel it later if you need.

    Declaration

    Swift

    public typealias DownloadTaskUpdatedBlock = ((_ newTask: DownloadTask?) -> Void)
  • KingfisherOptionsInfo is a typealias for [KingfisherOptionsInfoItem]. You can use the enum of option item with value to control some behaviors of Kingfisher.

    Declaration

    Swift

    public typealias KingfisherOptionsInfo = [KingfisherOptionsInfoItem]
  • Represents the type of transformer method, which will be used in to provide a Filter.

    Declaration

    Swift

    public typealias Transformer = (CIImage) -> CIImage?
  • Progress update block of prefetcher when initialized with a list of resources.

    • skippedResources: An array of resources that are already cached before the prefetching starting.
    • failedResources: An array of resources that fail to be downloaded. It could because of being cancelled while downloading, encountered an error when downloading or the download not being started at all.
    • completedResources: An array of resources that are downloaded and cached successfully.

    Declaration

    Swift

    public typealias PrefetcherProgressBlock = ((_ skippedResources: [Resource], _ failedResources: [Resource], _ completedResources: [Resource]) -> Void)
  • Progress update block of prefetcher when initialized with a list of resources.

    • skippedSources: An array of sources that are already cached before the prefetching starting.
    • failedSources: An array of sources that fail to be fetched.
    • completedResources: An array of sources that are fetched and cached successfully.

    Declaration

    Swift

    public typealias PrefetcherSourceProgressBlock = ((_ skippedSources: [Source], _ failedSources: [Source], _ completedSources: [Source]) -> Void)
  • Completion block of prefetcher when initialized with a list of sources.

    • skippedResources: An array of resources that are already cached before the prefetching starting.
    • failedResources: An array of resources that fail to be downloaded. It could because of being cancelled while downloading, encountered an error when downloading or the download not being started at all.
    • completedResources: An array of resources that are downloaded and cached successfully.

    Declaration

    Swift

    public typealias PrefetcherCompletionHandler = ((_ skippedResources: [Resource], _ failedResources: [Resource], _ completedResources: [Resource]) -> Void)
  • Completion block of prefetcher when initialized with a list of sources.

    • skippedSources: An array of sources that are already cached before the prefetching starting.
    • failedSources: An array of sources that fail to be fetched.
    • completedSources: An array of sources that are fetched and cached successfully.

    Declaration

    Swift

    public typealias PrefetcherSourceCompletionHandler = ((_ skippedSources: [Source], _ failedSources: [Source], _ completedSources: [Source]) -> Void)
  • Undocumented

    Declaration

    Swift

    public typealias IndicatorView = NSView