Type alias DeleteConnectionOptions

DeleteConnectionOptions: {
    endpointToIgnore?: Endpoint<any>;
    fireEvent?: boolean;
    force?: boolean;
    originalEvent?: Event;

Optional parameters to the DeleteConnection method.

Type declaration

  • Optional endpointToIgnore?: Endpoint<any>

    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.

  • Optional fireEvent?: boolean

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

  • Optional force?: boolean

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

  • Optional originalEvent?: Event

    Optional original event that resulted in the connection being deleted.