delete method

Future<DeleteResult> delete(
  1. StreamState state, {
  2. UserCredentials? userCredentials,
  3. EventStoreClientOperationOptions? operationOptions,
})

Perform a soft delete of all events in stream. When a stream is soft-deleted, all events from the stream get scavenged during the next scavenging run. It means that you can reopen the stream by appending to it again. See deleting streams and events

Implementation

Future<DeleteResult> delete(
  StreamState state, {
  UserCredentials? userCredentials,
  EventStoreClientOperationOptions? operationOptions,
}) {
  return $runRequest<DeleteResult>(() async {
    final request = state.toDeleteReq();
    final client = await $getClient();
    final result = await client.delete(
      request,
      options: $getOptions(
        userCredentials: userCredentials,
        operationOptions: operationOptions,
      ),
    );
    return DeleteResult.fromDeleteResp(state, result);
  });
}