withCancelToken method

Context withCancelToken(
  1. CancelToken token
)

Attaches a Dio CancelToken to this request context.

This allows cancelling in-flight GraphQL requests, which is especially useful in Flutter when a widget is disposed.

Example:

final cancelToken = CancelToken();
final response = await client.execute(
  query,
  context: Context().withCancelToken(cancelToken),
);
// Later, to cancel:
cancelToken.cancel('Widget disposed');

Implementation

Context withCancelToken(CancelToken token) {
  return withEntry(DioLinkCancelTokenContextEntry(token));
}