Skip to content

Consider options rename #13

@austinkelleher

Description

@austinkelleher

Problem

I think that the option names for Redis host and port should be renamed to be more Redis specific. When looking at the configuration in your SocketCluster project, it is unclear what the host and port properties are used for.

Proposal

Old:

const socketCluster = new SocketCluster({
  brokerOptions: {
    host: '54.204.147.15',
    port: 6379
  }
});

New:

const socketCluster = new SocketCluster({
  brokerOptions: {
    redis: {
      host: '54.204.147.15',
      port: 6379
      // Also supports easily passing additional options in the future
    }
  }
});

@jondubois I would be happy to work on this change if we decide this is the right direction.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions