Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix!: make PublishError.InsufficientPeers more self-explanatory #487

Merged
merged 1 commit into from
Feb 27, 2024

Commits on Feb 2, 2024

  1. fix!: make PublishError.InsufficientPeers more self-explanatory

    People continually mistake the `InsufficientPeers` error for something
    that can be "worked around" by setting `allowPublishToZeroPeers` to true,
    and they then expect other network nodes to still recieve their messages.
    
    This PR renames the option to `allowPublishToZeroTopicPeers` - this makes
    it clear(er) that it's not that you don't have any peers, it's that no
    peers you have are listening on the topic.
    
    It also improves the JSDoc comment on the option and changes the `Error`
    message from `PublishError.InsufficientPeers` to `PublishError.NoPeersSubscribedToTopic`
    which (I hope) more accurately describes what's wrong.
    
    BREAKING CHANGE: The `allowPublishToZeroPeers` option has been renamed to `allowPublishToZeroTopicPeers`
    
    Fixes #472
    achingbrain committed Feb 2, 2024
    Configuration menu
    Copy the full SHA
    435e8dd View commit details
    Browse the repository at this point in the history