Type Alias DeleteConnectionOptions

Optional parameters to the DeleteConnection method.

type DeleteConnectionOptions = {
    endpointToIgnore?: Endpoint;
    fireEvent?: boolean;
    force?: boolean;
    originalEvent?: Event;
}

Properties

endpointToIgnore?: Endpoint

internally when a connection is deleted, it may be because the endpoint it was on is being deleted. in that case we want to ignore that endpoint.

fireEvent?: boolean

If false, an event won't be fired. Otherwise a connection:detach event will be fired.

force?: boolean

if true, force deletion even if the connection tries to cancel the deletion.

originalEvent?: Event

Optional original event that resulted in the connection being deleted.