# @flare-engine/share 中文文档

规范地址：https://npmcn.com/package/%40flare-engine/share/

版本：0\.4\.12
npm 元数据更新时间：2026-11-12T19:45:58.758Z
中文译文更新时间：2026-11-14T22:48:41.219Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40flare-engine/share
原文对照：https://npmcn.com/package/%40flare-engine/share/?lang=original
项目主页：https://github.com/grzott/flare-engine#readme
源码仓库：https://github.com/grzott/flare-engine

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

- 包体积（解压后）：89.7 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-06-09T16:19:46.315Z
- 最新版本发布：2026-11-12T19:45:58.343Z
- 近 30 天下载量：2322（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

屏幕截取 + 跨平台共享表

## 安装

```sh
npm install @flare-engine/share
```

也可以使用：`pnpm add @flare-engine/share`、`yarn add @flare-engine/share`、`bun add @flare-engine/share`

## README

# @flare-engine/share (英语)

跨平台截图抓取( Skia) `makeImageSnapshot`) + 有可插件的共享表管弦乐. `captureScreenshot(source, opts?)` 返回时 `{ bytes, base64, format, width, height }`。 。 。 . `ShareManager` 通过注册运输的级联——第一个 `canShare(payload)` 返回真正的胜利。 内建运输覆盖了Web Share API,Web Clipboard回落,原生RN `Share`,以及 `expo-sharing` (图像文件,用于Android截图). `createScreenshotScene` 电线为存储资产工作流程的一发捕捉场景.

## 安装

```sh
bun add @flare-engine/share
```

## 使用量

```ts
import { Share } from 'react-native';
import { captureScreenshot, ShareManager, createNativeShareTransport,
         createWebShareTransport, createWebClipboardTransport } from '@flare-engine/share';
import type { CaptureSource } from '@flare-engine/share';

declare const source: CaptureSource;

const shot = captureScreenshot(source, { format: 'png' });

const share = new ShareManager()
  .register(createNativeShareTransport(Share))
  .register(createWebShareTransport(navigator, File))
  .register(createWebClipboardTransport(navigator));

if (shot) {
  await share.share({ message: 'New high score! https://example.com', screenshot: shot });
}
```

平台注释:

-   `createWebShareTransport` 附加截图为 `File` 浏览器时 `navigator.canShare({ files })` 接受这个.
-   `createNativeShareTransport` 在iOS上标注为 `data:image/<format>;base64,…` URL,仅限 何时 `url` 是未设定的——一个明确的 `url` 胜出时没有图像连接 。 Android的RN (英语) `Share` 仅转发 `title` 财务报告和审定财务报表 `message`,所以在 `message`图像没有附着在那里, 和带有截图但无 `message` 打开一个仍为报告的空工作表 `dispatched: true`。 。 。 .
-   `createWebClipboardTransport` 副本 `message` 财务报告和审定财务报表 `url` 只有文本.
-   `createExpoShareTransport` 共享截图为图像文件;见下文.

## Android 截图

核弹 `Share` 无法在 Android 上附加图像 . `createExpoShareTransport(sharing, files)` 写入 将截图切入文件并将其 URI 交给 `expo-sharing`注册 **在此之前** 红色 运输: `canShare` 只有当有效载荷具有 `screenshot`,所以截图有效载荷 到达 `expo-sharing` 和仅文本的有效载荷流入RN `Share`。 。 。 .

```ts
import { Share } from 'react-native';
import * as Sharing from 'expo-sharing';
import { File, Paths } from 'expo-file-system';
import { createExpoShareTransport, createNativeShareTransport, ShareManager } from '@flare-engine/share';
import type { ShareFileWriterLike } from '@flare-engine/share';

const files: ShareFileWriterLike = {
  async writeBase64File(name, base64) {
    const f = new File(Paths.cache, name);
    await f.write(base64, { encoding: 'base64' });
    return f.uri;
  },
};

const share = new ShareManager()
  .register(createExpoShareTransport(Sharing, files))
  .register(createNativeShareTransport(Share));
```

`files` 一个回调,将 Base64 数据写入文件并解析其 URI 。 适配器 上方使用 `File` API 数据 `expo-file-system` 58号,其中 `write` 创建文件或覆盖 这个 与 `expo-file-system/legacy` 条目中,用这样的方式写:

```ts
import { cacheDirectory, writeAsStringAsync } from 'expo-file-system/legacy';
import type { ShareFileWriterLike } from '@flare-engine/share';

const files: ShareFileWriterLike = {
  async writeBase64File(name, base64) {
    const uri = `${cacheDirectory}${name}`;
    await writeAsStringAsync(uri, base64, { encoding: 'base64' });
    return uri;
  },
};
```

限制 :

-   `expo-sharing` 共享一个文件而无文本。 截图独出: `message` 财务报告和审定财务报表 `url` 被丢弃,以及 `title` 成为选择者的 `dialogTitle`。 。 。 .
-   文件总是被命名 `screenshot.<format>`,因此每个共享覆盖上一个共享.
-   结果是 `{ dispatched: true, via: 'native' }` 一旦工作表打开; `expo-sharing` 不表示用户是否完成了该共享。 何时 `isAvailableAsync()` 断绝虚假, 什么都没有写,结果就是 `{ dispatched: false, via: 'native' }`。失败的书写或 被拒绝 `shareAsync` 拒绝 `share()` 答应.

见 [API 规格](https://github.com/grzott/flare-engine/blob/main/docs/design/api-specs.md#flare-engineshare--5kb-raw)。 。 。 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @flare-engine/share 是什么？

屏幕截取 \+ 跨平台共享表

### 如何安装 @flare-engine/share？

在项目目录运行 npm install @flare-engine/share，或使用 pnpm add / yarn add / bun add。

### @flare-engine/share 支持 TypeScript 吗？

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

### @flare-engine/share 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flare-engine/share 需要什么版本的 Node\.js？

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

### @flare-engine/share 可以商用吗？

@flare-engine/share 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @flare-engine/share 的下载量有多少？

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

### @flare-engine/share 还在维护吗？

最新版本 0\.4\.12 发布于 2026/11/13（3 天前）；至今共发布 17 个版本，其中过去 12 个月发布了 17 个；首次发布于 2026/06/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

