Progress

current

static current(): (Progress) | null

class func current() -> Progress?

discreteProgress

static discreteProgress(unitCount: number): Progress

class func discreteProgress(totalUnitCount unitCount: Int64) -> Progress

init

static initTotalUnitCount(unitCount: number): Progress

init(totalUnitCount unitCount: Int64)

init

static initTotalUnitCountParentPendingUnitCount(unitCount: number, parent: Progress, portionOfParentTotalUnitCount: number): Progress

init(totalUnitCount unitCount: Int64, parent: Progress, pendingUnitCount portionOfParentTotalUnitCount: Int64)

addChild

addChildWithPendingUnitCount(child: Progress, inUnitCount: number): void

func addChild(_ child: Progress, withPendingUnitCount inUnitCount: Int64)

becomeCurrent

becomeCurrent(unitCount: number): void

func becomeCurrent(withPendingUnitCount unitCount: Int64)

cancel

cancel(): void

func cancel()

init

static initParentUserInfo(parentProgressOrNil?: (Progress) | null, userInfoOrNil?: (NativeMap<ProgressUserInfoKey, unknown>) | null): Progress

init(parent parentProgressOrNil: Progress?, userInfo userInfoOrNil: [ProgressUserInfoKey : Any]? = nil)

pause

pause(): void

func pause()

resignCurrent

resignCurrent(): void

func resignCurrent()

resume

resume(): void

func resume()

setUserInfoObject

setUserInfoObject(objectOrNil: (unknown) | null, key: ProgressUserInfoKey): void

func setUserInfoObject(_ objectOrNil: Any?, forKey key: ProgressUserInfoKey)

isCancellable

get isCancellable(): boolean

var isCancellable: Bool { get set }

isCancellable

set isCancellable(value: boolean)

var isCancellable: Bool { get set }

cancellationHandler

get cancellationHandler(): ((() => Promise<void>)) | null

var cancellationHandler: (@Sendable () -> Void)? { get set }

cancellationHandler

set cancellationHandler(value: ((() => void)) | null)

var cancellationHandler: (@Sendable () -> Void)? { get set }

isCancelled

get isCancelled(): boolean

var isCancelled: Bool { get }

completedUnitCount

get completedUnitCount(): number

var completedUnitCount: Int64 { get set }

completedUnitCount

set completedUnitCount(value: number)

var completedUnitCount: Int64 { get set }

fileOperationKind

get fileOperationKind(): (Progress_FileOperationKind) | null

var fileOperationKind: Progress.FileOperationKind? { get set }

fileOperationKind

set fileOperationKind(value: (Progress_FileOperationKind) | null)

var fileOperationKind: Progress.FileOperationKind? { get set }

fileURL

get fileURL(): (string) | null

var fileURL: URL? { get set }

fileURL

set fileURL(value: (string) | null)

var fileURL: URL? { get set }

isFinished

get isFinished(): boolean

var isFinished: Bool { get }

fractionCompleted

get fractionCompleted(): number

var fractionCompleted: Double { get }

isIndeterminate

get isIndeterminate(): boolean

var isIndeterminate: Bool { get }

kind

get kind(): (ProgressKind) | null

var kind: ProgressKind? { get set }

kind

set kind(value: (ProgressKind) | null)

var kind: ProgressKind? { get set }

localizedAdditionalDescription

get localizedAdditionalDescription(): (string) | null

var localizedAdditionalDescription: String! { get set }

localizedAdditionalDescription

set localizedAdditionalDescription(value: (string) | null)

var localizedAdditionalDescription: String! { get set }

localizedDescription

get localizedDescription(): (string) | null

var localizedDescription: String! { get set }

localizedDescription

set localizedDescription(value: (string) | null)

var localizedDescription: String! { get set }

isPausable

get isPausable(): boolean

var isPausable: Bool { get set }

isPausable

set isPausable(value: boolean)

var isPausable: Bool { get set }

isPaused

get isPaused(): boolean

var isPaused: Bool { get }

pausingHandler

get pausingHandler(): ((() => Promise<void>)) | null

var pausingHandler: (@Sendable () -> Void)? { get set }

pausingHandler

set pausingHandler(value: ((() => void)) | null)

var pausingHandler: (@Sendable () -> Void)? { get set }

resumingHandler

get resumingHandler(): ((() => Promise<void>)) | null

var resumingHandler: (@Sendable () -> Void)? { get set }

resumingHandler

set resumingHandler(value: ((() => void)) | null)

var resumingHandler: (@Sendable () -> Void)? { get set }

totalUnitCount

get totalUnitCount(): number

var totalUnitCount: Int64 { get set }

totalUnitCount

set totalUnitCount(value: number)

var totalUnitCount: Int64 { get set }

userInfo

get userInfo(): NativeMap<ProgressUserInfoKey, unknown>

var userInfo: [ProgressUserInfoKey : Any] { get }

throughput

get throughput(): (number) | null

var throughput: Int? { get set }

A value that represents the speed of data processing, in bytes per second. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

throughput

set throughput(value: (number) | null)

var throughput: Int? { get set }

A value that represents the speed of data processing, in bytes per second. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

fileTotalCount

get fileTotalCount(): (number) | null

var fileTotalCount: Int? { get set }

The total number of files for a file progress object. If the current progress is operating on a set of files, set this property to the total number of files in the operation. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

fileTotalCount

set fileTotalCount(value: (number) | null)

var fileTotalCount: Int? { get set }

The total number of files for a file progress object. If the current progress is operating on a set of files, set this property to the total number of files in the operation. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

performAsCurrent

performAsCurrent(unitCount: number, work: (() => unknown)): unknown

func performAsCurrent<ReturnType>(withPendingUnitCount unitCount: Int64, using work: () throws -> ReturnType) rethrows -> ReturnType

Retrieves the current thread's progress object, executes the specified block, and increments the progress object by the specified units of work. - Parameters: - unitCount: The number of units of work to increment for the current progress object. - work: A closure that wraps the work you specify to complete for incrementing the current progress. - Returns: The return value of the closure that you specify for the `work` parameter. Use this function as a convenience method to wrap an existing method or closure to increment the current progress object. This function is the same as calling `becomeCurrent(withPendingUnitCount:)`, doing the work you specify in the closure, and calling `resignCurrent()`.

fileCompletedCount

get fileCompletedCount(): (number) | null

var fileCompletedCount: Int? { get set }

The number of completed files for a file progress object. If the current progress is operating on a set of files, set this property to the number of completed files in the operation. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

fileCompletedCount

set fileCompletedCount(value: (number) | null)

var fileCompletedCount: Int? { get set }

The number of completed files for a file progress object. If the current progress is operating on a set of files, set this property to the number of completed files in the operation. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

estimatedTimeRemaining

get estimatedTimeRemaining(): (number) | null

var estimatedTimeRemaining: TimeInterval? { get set }

A value that indicates the estimated amount of time remaining to complete the progress, in seconds. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

estimatedTimeRemaining

set estimatedTimeRemaining(value: (number) | null)

var estimatedTimeRemaining: TimeInterval? { get set }

A value that indicates the estimated amount of time remaining to complete the progress, in seconds. If present, `Progress` presents additional information in its localized description by setting a value in the `userInfo` dictionary.

addChild

addChildWithPendingUnitCount90133(reporter: ProgressReporter, count: number): void

func addChild(_ reporter: ProgressReporter, withPendingUnitCount count: Int)

Adds a ProgressReporter as a child to a Progress, which constitutes a portion of Progress's totalUnitCount. - Parameters: - reporter: A `ProgressReporter` instance. - count: Number of units delegated from `self`'s `totalCount`.