request property

ZipRequestFunction<T> request
final

The callback-based request method reference or closure.

This can be either:

  • Method reference: Direct reference to a callback-based method
  • Closure: Lambda that wraps the method call with parameters

The closure pattern is recommended for most cases as it provides better type safety and clarity.

Type Signature

When using the closure pattern, the function signature is:

void Function({
  Success<T>? success,
  Failure? failure,
  Completed? completed,
})

Example with closure (IDE will autocomplete parameters):

request: ({success, failure, completed}) {
  getUserAsync(
    userId: '123',
    success: success,      // Success<UserInfo>?
    failure: failure,      // Failure?
    completed: completed,  // Completed?
  );
}

Callback Parameter Details

  • success: void Function(T data, SourcesType source)

    • Called when request succeeds
    • data: The result data of type T
    • source: Where data came from (cache, network, etc.)

  • failure: void Function(dynamic error)

    • Called when request fails
    • error: Error information from the failed request

  • completed: void Function()

    • Called when request finishes (regardless of success/failure)
    • Useful for cleanup or hiding loading indicators

Implementation

final ZipRequestFunction<T> request;