tombstone method

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

Perform a hard delete of stream. When using hard delete, the stream gets closed with a tombstone event. Such an event tells the database that the stream cannot be reopened, so any attempt to append to the hard-deleted stream will fail. See deleting streams and events

Implementation

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