@graphql-sse/client

中文文档
0.0.16发布于 2021/10/10MITTypeScriptCommonJS近 30 天下载 1.9万

图QL 订阅客户端

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 基本示例
  4. 阿波罗客户端示例

@graphql-sse/ 客户端

一个使用 Server Sent Events 订阅 GraphQL 的客户端 .

安装

npm install @graphql-sse/client

使用量

基本示例

import {
  SubscriptionClient,
  SubscriptionClientOptions,
} from '@graphql-sse/client';

const subscriptionClient = SubscriptionClient.create({
    graphQlSubscriptionUrl: 'http://some.host/graphl/subscriptions'
});

subscriptionClient.subscribe(
    operation
)    

阿波罗客户端示例

在这个例子中,我们将创建一个 Apollo Client 链接,我们后来在初始化我们的 apollo 客户端时使用.

import { ApolloLink, Operation, FetchResult, Observable } from '@apollo/client';
import {
  SubscriptionClient,
  SubscriptionClientOptions,
} from '@graphql-sse/client';

export class ServerSentEventsLink extends ApolloLink {
  private subscriptionClient: SubscriptionClient;
  constructor(
    options: SubscriptionClientOptions
  ) {
    super();
    this.subscriptionClient = SubscriptionClient.create(options);
  }

  public request(operation: Operation): Observable<FetchResult> | null {
    return this.subscriptionClient.subscribe(
      operation
    ) as Observable<FetchResult>;
  }
}

现在可以使用所创建的阿波罗客户端链接进行订阅.

import { split, HttpLink, ApolloClient, InMemoryCache } from '@apollo/client';
import { getMainDefinition } from '@apollo/client/utilities';
import { ServerSentEventsLink } from './server-sent-events-link';

const httpLink = new HttpLink({
  uri: 'http://localhost:4000/graphql',
});

const sseLink = new ServerSentEventsLink({
  graphQlSubscriptionUrl: 'http://localhost:4000/graphql',
});

const splitLink = split(
  ({ query }) => {
    const definition = getMainDefinition(query);
    return (
      definition.kind === 'OperationDefinition' &&
      definition.operation === 'subscription'
    );
  },
  sseLink,
  httpLink
);

export const client = new ApolloClient({
  link: splitLink,
  cache: new InMemoryCache(),
});

说明: 或者,你可以使用 @graphql-sse/apollo-client 包着这个 @graphql-sse/client见 示例反应应用

版本与发布记录

@graphql-sse/client 共发布 9 个版本,首次发布于 2021/09/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.16latest2021/10/105 年前
0.0.152021/10/105 年前
0.0.132021/09/225 年前
0.0.122021/09/225 年前
0.0.102021/09/225 年前
0.0.72021/09/225 年前

关于 @graphql-sse/client 的常见问题

@graphql-sse/client 是什么?

图QL 订阅客户端

如何安装 @graphql-sse/client?

在项目目录运行 npm install @graphql-sse/client,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:graphql(>=0.11 <=16)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphql-sse/client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graphql-sse/client 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@graphql-sse/client 可以商用吗?

@graphql-sse/client 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@graphql-sse/client 的下载量有多少?

根据 npm 官方下载统计,@graphql-sse/client 在 2026/10/17 – 2026/11/15 这 30 天内被下载 19,271 次,日均约 642 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graphql-sse/client 还在维护吗?

最新版本 0.0.16 发布于 2021/10/10(5 年前);至今共发布 9 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/09/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。