@shelf/pspdfkit-ssr

中文文档
4.0.1发布于 2023/11/13MITTypeScriptCommonJS

Utilities to work with PSPDFKit's server-side rendering

此软件包已被标记为弃用

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

原始使用文档
文档目录4 节
  1. Install
  2. Usage
  3. Publish
  4. License

pspdfkit-ssr CircleCI npm (scoped)

Install

$ yarn add @shelf/pspdfkit-ssr

Usage

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);

Note: this library relies upon following environment variables:

  • PSPDFKIT_SERVER_URL
  • PSPDFKIT_SERVER_AUTH_TOKEN
  • PSPDFKIT_SERVER_JWT_KEY
  • PSPDFKIT_SERVER_JWT_PASSPHRASE

Note: this library tries to be idempotent. Unlike PSPDFKit server, it catches errors when document with provided ID was already uploaded.

See Client Authentication section of PSPDFKit documentation for details.

Publish

  • Run sudo npx np, follow interactive UI. Please select appropriate version bump according to semver.

  • After redirect to the prepared release of the early published package just press button Publish release

License

MIT © Shelf

版本与发布记录

@shelf/pspdfkit-ssr 共发布 16 个版本,首次发布于 2019/06/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.0.1latest2023/11/132 年前
3.2.02023/09/153 年前
3.1.42023/09/063 年前
3.1.32023/09/063 年前
3.0.02022/07/164 年前
2.1.52021/12/154 年前

关于 @shelf/pspdfkit-ssr 的常见问题

@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。作者已将其标记为弃用,新项目建议寻找替代方案。