加入我们,10月8日至10日纽约市,了解 GraphQL 联邦和 API 平台工程的最最新技巧、趋势和新闻。加入我们,参加2024年纽约市的 GraphQL 大会
文档
免费开始

WebSocket 链接

使用 subscriptions-transport-ws 库在 WebSocket 上执行订阅(或其他操作)


⚠️ 我们不再推荐使用 WebSocketLinksubscriptions-transport-ws,因为该库不再积极维护。要执行 ,我们建议使用较新的 graphql-ws 库及其相关库。GraphQLWsLink.

无论您使用哪个库,请确保您的服务器和所有支持的客户端使用相同的库。更多信息,请参阅 选择订阅库

在学习单个链接之前,建议您先阅读 Apollo Link 概述

`WebSocketLink` 是一个 终止链接,通常与 订阅(通常通过 WebSocket 进行通信)一起使用,尽管也可以通过 WebSocket 发送查询和

WebSocketLink库需要subscriptions-transport-ws。在项目中按以下方式安装它:

npm install subscriptions-transport-ws

构造函数

import { WebSocketLink } from "@apollo/client/link/ws";
import { SubscriptionClient } from "subscriptions-transport-ws";
const link = new WebSocketLink(
new SubscriptionClient("ws://127.0.0.1:4000/graphql", {
reconnect: true
})
);

选项

WebSocketLink的构造函数可以接受一个SubscriptionClient对象或一个包含以下字段的选项对象。 (这些选项直接传递到SubscriptionClient的构造函数。)

名称
类型
描述
uri

字符串

必须。连接到WebSocket端点的URL(例如,ws://127.0.0.1:4000/subscriptions)。

options

对象

WebSocket连接的配置选项。

查看支持的选项

webSocketImpl

对象

一个符合W3C规范的WebSocket实现。如果您的环境不提供本地WebSocket支持(例如在Node.js中),请提供此选项。

用法

参见订阅

上一页
订阅(较新协议)
下一页
社区链接
评价文章评价在GitHub上编辑编辑论坛Discord

©2024Apollo Graph Inc.,即Apollo GraphQL。

隐私政策

公司