1. Home
  2. graphql-ws
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client
graphql-ws
Package: graphql-ws
Created by: enisdenjo
Last modified: Wed, 27 Mar 2024 20:24:47 GMT
Version: 5.16.0
License: MIT
Downloads: 18,456,150
Repository: https://github.com/enisdenjo/graphql-ws

Install

npm install graphql-ws
yarn add graphql-ws

GraphQLOverWebSocket

Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.

Continuous integration graphql-ws

Use Server-Sent Events (SSE) instead? Check out graphql-sse!


Get started

Swiftly start with the get started guide on the website.

Recipes

Short and concise code snippets for starting with common use-cases. Available on the website.

Documentation

Auto-generated by TypeDoc and then rendered on the website.

How does it work?

Read about the exact transport intricacies used by the library in the GraphQL over WebSocket Protocol document.

Want to help?

File a bug, contribute with code, or improve documentation? Read up on our guidelines for contributing and drive development with yarn test --watch away!

Disclaimer

This library and the GraphQL over WebSocket Protocol are not cross-compatible with the deprecated subscriptions-transport-ws and its accompanying Protocol.

You must use graphql-ws coherently and implement the GraphQL over WebSocket Protocol on both sides, server and the client.

Dependencies

@babel/core: ^7.22.5@babel/plugin-proposal-class-properties: ^7.18.6@babel/plugin-proposal-nullish-coalescing-operator: ^7.18.6@babel/plugin-proposal-object-rest-spread: ^7.20.7@babel/plugin-proposal-optional-chaining: ^7.21.0@babel/preset-env: ^7.22.5@babel/preset-typescript: ^7.22.5@fastify/websocket: ^7.2.0@rollup/plugin-terser: ^0.4.3@rollup/plugin-typescript: ^11.1.1@semantic-release/changelog: ^6.0.3@semantic-release/git: ^10.0.1@types/eslint: ^8.40.2@types/glob: ^8.1.0@types/jest: ^29.5.2@types/ws: ^8.5.5@typescript-eslint/eslint-plugin: ^5.60.0@typescript-eslint/parser: ^5.60.0babel-jest: ^29.5.0bun-types: ^0.6.9eslint: ^8.43.0eslint-config-prettier: ^8.8.0fastify: ^4.18.0fastify-websocket: 4.2.2glob: ^10.3.0graphql: ^16.7.0jest: ^29.5.0jest-environment-jsdom: ^29.5.0jest-jasmine2: ^29.5.0prettier: ^2.8.8replacestream: ^4.0.3rollup: ^3.25.1semantic-release: ^21.0.5subscriptions-transport-ws: ^0.11.0tslib: ^2.5.3typedoc: ^0.24.8typedoc-plugin-markdown: ^3.15.3typescript: ^5.1.3uWebSockets.js: github:uNetworking/uWebSockets.js#v20.30.0ws: 8.12.0ws7: npm:ws@^7.5.9

RELATED POST

Enhancing Vue.js Development: Harnessing the Potential of Vue-Loader

Enhancing Vue.js Development: Harnessing the Potential of Vue-Loader

Simplify Data Validation in Vue.js: A Step-by-Step Guide to Using Regex

Simplify Data Validation in Vue.js: A Step-by-Step Guide to Using Regex

Troubleshooting Made Easy: Common Issues and Solutions with vue-loader Without vue-cli

Troubleshooting Made Easy: Common Issues and Solutions with vue-loader Without vue-cli

Optimizing Webpack 4 with Vue CLI 3: Disabling the Cache-Loader

Optimizing Webpack 4 with Vue CLI 3: Disabling the Cache-Loader

Step-by-Step Guide: How to Add a Function to Your Vuex Plugin

Step-by-Step Guide: How to Add a Function to Your Vuex Plugin

© 2023 Vuejscomponent All Rights Reserved

Introducing a blog that delves into the exciting world of Vue.js components. Stay tuned for insightful examples and valuable insights that will elevate your Vue.js development skills.