apollographql / apollographql/graphql-subscriptions

Usage with native WebSocket API on the client

Open
#226 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1.6k
Forks
129
PR merge metrics
No merged PRs in 30d

Description

Hi :wave:

I'm a bit confused about something in the readme :
``
This package should be used with a network transport, for example subscriptions-transport-ws.
``
Network transport is broad. For me, a "network transport" could be a simple websocket server, and client-side, any usage of the WebSocket API. But then, why taking as example another library ?

Can we find somewhere some specification about implementing our own "network transport" ?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the README passage that describes subscriptions-transport-ws as a network transport and the surrounding usage guidance. Document the expected interface or protocol for a custom network transport, including whether the native client-side WebSocket API is sufficient, and make the guidance actionable for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.