# @shelf/pspdfkit-ssr 中文文档

规范地址：https://npmcn.com/package/%40shelf/pspdfkit-ssr/

版本：4\.0\.1
npm 元数据更新时间：2026-11-02T10:17:10.047Z
中文译文更新时间：2026-11-02T11:25:28.894Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40shelf/pspdfkit-ssr
原文对照：https://npmcn.com/package/%40shelf/pspdfkit-ssr/?lang=original
源码仓库：https://github.com/shelfio/pspdfkit-ssr

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.1 kB，18 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16
- 运行依赖：4 个
- 首次发布：2019-06-13T10:47:22.367Z
- 最新版本发布：2023-11-13T14:21:50.651Z
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

与PSPDFKit的服务器端渲染工作的实用程序

## 安装

```sh
npm install @shelf/pspdfkit-ssr
```

也可以使用：`pnpm add @shelf/pspdfkit-ssr`、`yarn add @shelf/pspdfkit-ssr`、`bun add @shelf/pspdfkit-ssr`

## README

# pspdfkit-ssr [![CircleCI](https://circleci.com/gh/shelfio/pspdfkit-ssr/tree/master.svg?style=svg)](https://circleci.com/gh/shelfio/pspdfkit-ssr/tree/master) ![](https://img.shields.io/badge/code_style-prettier-ff69b4.svg) [![npm (scoped)](https://img.shields.io/npm/v/@shelf/pspdfkit-ssr.svg)](https://www.npmjs.com/package/@shelf/pspdfkit-ssr)

## 安装

```
$ yarn add @shelf/pspdfkit-ssr
```

## 使用

```js
const {createReadStream} = require('fs');
const {uploadPDF, getJWTForDocumentPreview} = require('@shelf/pspdfkit-ssr');

const documentId = await uploadPDF({
  documentId: 'some-custom-document-id',
  fileStream: createReadStream('./file.pdf'),
  fileSize: 1024,
});

const jwt = getJWTForDocumentPreview(documentId);
```

**注意：** 此库依赖于以下环境变量：

-   `PSPDFKIT_SERVER_URL`
-   `PSPDFKIT_SERVER_AUTH_TOKEN`
-   `PSPDFKIT_SERVER_JWT_KEY`
-   `PSPDFKIT_SERVER_JWT_PASSPHRASE`

**注意：** 这个库试图是幂等的。 与PSPDFKit服务器不同，当提供ID的文档已经上传时，它会捕获错误。

看到 [客户端身份验证](https://pspdfkit.com/guides/server/current/pspdfkit-server/client-authentication/) 部分的PSPDFKit文档的详细信息。

## 发布

-   运行 `sudo npx np`，遵循交互式UI。请根据。选择合适的版本 [semver](https://semver.org/).
    
-   在重定向到预先发布的包的准备版本后，只需按一下按钮 `Publish release`
    

## 许可证

麻省理工学院© [架子上](https://shelf.io/)

## 常见问题

### @shelf/pspdfkit-ssr 是什么？

与PSPDFKit的服务器端渲染工作的实用程序注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @shelf/pspdfkit-ssr？

在项目目录运行 npm install @shelf/pspdfkit-ssr，或使用 pnpm add / yarn add / bun add。

### @shelf/pspdfkit-ssr 支持 TypeScript 吗？

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

### @shelf/pspdfkit-ssr 支持 ESM 还是 CommonJS？

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

### @shelf/pspdfkit-ssr 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @shelf/pspdfkit-ssr 可以商用吗？

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

### @shelf/pspdfkit-ssr 还在维护吗？

最新版本 4\.0\.1 发布于 2023/11/13（2 年前）；至今共发布 16 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/06/13。作者已将其标记为弃用，新项目建议寻找替代方案。