mutateCancellable<TParsed> method

CancellableOperation<QueryResult<TParsed>> mutateCancellable<TParsed>(
  1. MutationOptions<TParsed> options
)

Executes a mutation that can be cancelled via the returned CancellableOperation.

This is a convenience method that creates a CancellationToken for you and returns both the result future and the token wrapped in a CancellableOperation.

{@tool snippet} Basic usage

final operation = client.mutateCancellable(
  MutationOptions(
    document: gql('mutation { ... }'),
  ),
);

// Later, if you need to cancel:
operation.cancel();

// The result future completes with a QueryResult whose exception is set
final result = await operation.result;
if (result.exception?.linkException is CancelledException) {
  // Handle cancellation
}

{@end-tool}

Implementation

CancellableOperation<QueryResult<TParsed>> mutateCancellable<TParsed>(
  MutationOptions<TParsed> options,
) {
  final cancellationToken = CancellationToken();
  final policies = defaultPolicies.mutate.withOverrides(options.policies);
  final modifiedOptions = options
      .copyWithPolicies(policies)
      .copyWith(cancellationToken: cancellationToken);
  return CancellableOperation(
    result: queryManager.mutate(modifiedOptions),
    cancellationToken: cancellationToken,
  );
}