cancellation_token 1.6.1

cancellation_token: ^1.6.1 copied to clipboard

• Include Dart SDK license in license file.

• Added CancellableIsolate.run(), based on the new Isolate.run() method in Dart 2.19.0.
• Updated cancellableCompute to use CancellableIsolate.run() internally.
• Increased minimum Dart SDK to 2.19.0.

• Added MergedCancellationToken to combine multiple cancellation tokens into one.
• Added cancellableFutureOr() to simplify cancellation when working with FutureOr types.
• Added onError, whenComplete, and whenCompleteOrCancelled params to ignoreCancellation(). This change doesn't impact existing usage.

• Added new static functions to CancellableFuture to make the API more similar to Dart's Future:
  • Future() ➡️ CancellableFuture.from()
  • Future.microtask() ➡️ CancellableFuture.microtask()
  • Future.sync() ➡️ CancellableFuture.sync()
  • Future.value() ➡️ CancellableFuture.value()
  • Future.delayed() ➡️ CancellableFuture.delayed()
• Breaking: The CancellableFuture constructor is now private. Calls to this constuctor should be replaced with .asCancellable() or CancellableFuture.value():

  // Removed:
  // await CancellableFuture(exampleFuture, cancellationToken).future;
  
  // Recommended:
  await exampleFuture.asCancellable(cancellationToken);
  

• Updated cancellableCompute with the latest changes from the Flutter SDK's compute function (see flutter/flutter#99527).

• Rename the onCancel method's trace parameter to stackTrace.
• Add Cancellation Token HTTP example to README.

• Fix CancellableCompute web implementation.

• Added hasCancellables to CancellationToken.

• Bugfix: Fix exception if a Cancellable calls cancellationToken.detach(this) in its onCancel method.

• Added CancellableCompleter.sync constructor to match Dart's Completer.
• Added ignoreCancellations() convenience function for silently catching cancellation exceptions.
• Added example project.
• StackTraces are now included when cancelling (experimental).
• Bugfix: Calling the .exception getter on a CancellationToken will no longer create a new CancelledException instance every time.
• Bugfix: Fixed uncaught exceptions.

• Added support for nullable CancellationTokens, allowing functions/classes to be made cancellable without breaking existing implementations.

• Bugfix: Add missing cancellableCompute export.

• Added cancellableCompute() for running isolates that can be killed using a CancellationToken.
• Increased minimum Dart SDK to 2.15.0.

Initial release