cancelation_token

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The cancelation_token package offers a clean interface for managing cancellation in asynchronous operations, supporting various implementations like cancelable tasks, timeouts, and composite tokens. It enables developers to gracefully handle operation cancellation across platforms, improving responsiveness and resource management in Flutter apps. Ideal for scenarios involving network requests, timers, or long-running computations that may need to be interrupted. The package is lightweight and designed for use with Dart's async/await patterns.

Use cases

Managing cancellable network requests
Implementing timeout mechanisms
Coordinating multiple async operations
Handling user-initiated task cancellation
Controlling long-running background processes

Key features

Support for cancelable futures
Timeout-based cancellation
Composite token grouping
Cross-platform compatibility
Simple API integration

Suitable for

Developers needing fine-grained control over async operations
Apps with frequent network or timer usage
State management systems requiring cancellation support
Teams prioritizing clean async code structure

Considerations

Requires understanding of async/await flow
May add complexity for simple use cases
Not suitable for non-async operations
Limited documentation beyond basic examples
Best used with other state management solutions

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

This package provides an interface for cancelation tokens as well as various implementations:

CancelableToken which can be canceled programmatically;
CompositeToken which is canceled when any or all tokens are canceled;
TimeoutToken which is canceled after a timeout period.

Example

Cancel a long-running execution after a timeout.

import 'package:cancelation_token/cancelation_token.dart';

void main() async {
  final timeout = Duration(seconds: 5);
  final errorOnTimeout = CanceledException.withStackTrace('Too long!');
  final token = TimeoutToken(timeout, errorOnTimeout);
  token.ensureStarted();

  try {
    await longProcess(token);
  } on CanceledException catch (ex, st) {
    print(ex.message);
    print(ex.stackTrace);
    print(st);
  }
}

Future<void> longProcess(CancelationToken token) async {
  // very long indeed!
  while (true) {
    token.throwIfCanceled();
    await Future.delayed(const Duration(milliseconds: 100));
  }
}

Search packages, repositories and app categories