pusher / pusher/pusher-websocket-react-native
Insufficient Information in Documentation Regarding Custom Auth Endpoint Configuration
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 76
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
Description
The documentation for Pusher WebSocket in React Native lacks the necessary information and clarity concerning the configuration of the custom auth endpoint field.
await pusher.init({
apiKey: API_KEY,
cluster: API_CLUSTER,
authEndPoint: "https://your-server.com/pusher/auth"
});
What type of content should be returned from the custom auth endpoint?
Is there a way to pass additional properties to the endpoint? As far as I know, only the URL can be passed, but there seems to be missing information on this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Pusher WebSocket React Native documentation around the authEndPoint option and the custom auth endpoint example shown in the issue. Determine the expected response content and whether additional properties can be sent, then document those details and verify that the example accurately reflects the SDK configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100