# @canva/user 中文文档

规范地址：https://npmcn.com/package/%40canva/user/

版本：2\.3\.0
npm 元数据更新时间：2026-10-05T00:05:53.059Z
中文译文更新时间：2026-11-09T01:22:48.175Z
软件包许可：SEE LICENSE IN LICENSE\.md FILE

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

原始 npm 页面：https://www.npmjs.com/package/%40canva/user
原文对照：https://npmcn.com/package/%40canva/user/?lang=original

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

- 包体积（解压后）：56.3 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@canva/error ^2\.0\.0
- 首次发布：2023-11-17T03:51:34.093Z
- 最新版本发布：2026-10-05T00:05:52.900Z
- 近 30 天下载量：112012（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 8 个）

## 中文简介

Canva 开发者 SDK 用于 Canva 内部应用的用户库

## 安装

```sh
npm install @canva/user
```

也可以使用：`pnpm add @canva/user`、`yarn add @canva/user`、`bun add @canva/user`

## README

# @ canva/ 用户

一个Canva开发者SDK软件包,用于Canva内部构建应用软件. 提供获取用户数据和认证用户的方法.

![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

## 目录

-   [导言](https://npmcn.com/package/%40canva/user/#readme-introduction)
-   [安装](https://npmcn.com/package/%40canva/user/#readme-installation)
-   [使用量](https://npmcn.com/package/%40canva/user/#readme-usage)
-   [API 参考](https://npmcn.com/package/%40canva/user/#readme-api-reference)
-   [相关软件包](https://npmcn.com/package/%40canva/user/#readme-related-packages)
-   [捐款](https://npmcn.com/package/%40canva/user/#readme-contributing)
-   [许可证](https://npmcn.com/package/%40canva/user/#readme-license)

## 导言

`@canva/user` 是 npm 建设软件包 [canva 内部的应用程序](https://www.canva.dev/docs/apps/apps-inside-canva/apps-inside-canva/) 与 Canva 开发者 SDK 。 它提供了获取用户数据和认证用户的方法. 例如 `oauth.requestAuthorization` 方法会促使用户通过使用OAuth的第三方平台对应用进行认证.

**说明:** 要与 Canva 开发者 SDK 一同起来运行, 请检查 [快速启动指南](https://www.canva.dev/docs/apps/quickstart/)。 。 。 .

## 安装

```bash
npm install @canva/user
```

## 使用量

1.  导入方法或命名空间 `@canva/user` 软件包 :
    
    ```ts
    import { auth } from '@canva/user';
    ```
    
2.  调用方法, 在所需的参数中传递( 如果有):
    
    ```ts
    const oauth = auth.initOauth();
    const response = await oauth.requestAuthorization();
    ```
    

## API 参考

-   [`auth.initOauth`](https://www.canva.dev/docs/apps/api/user-auth-init-oauth/)
-   [`auth.getCanvaUserToken`](https://www.canva.dev/docs/apps/api/user-auth-get-canva-user-token/)

## 相关软件包

Canva内部的App是用以下 Canva 开发者 SDK 包构建的 :

-   [`@canva/app-ui-kit`](https://www.npmjs.com/package/@canva/app-ui-kit) - 基于反应的组件库,用于创建模仿Canva外观和感觉的应用程序.
-   [`@canva/asset`](https://www.npmjs.com/package/@canva/asset) - 提供处理资产的方法,例如图像和录像文件.
-   [`@canva/design`](https://www.npmjs.com/package/@canva/design) - 提供与用户设计互动的方法,例如创建要素.
-   [`@canva/error`](https://www.npmjs.com/package/@canva/error) - 提供 `CanvaError` 处理错误的课.
-   [`@canva/platform`](https://www.npmjs.com/package/@canva/platform) - 提供实用方法,例如打开外部链接的方法.
-   [`@canva/user`](https://www.npmjs.com/package/@canva/user) - 提供获取用户数据和认证用户的方法.

## 捐款

我们正在积极开发这个一揽子计划,但目前不接受第三方的捐款. 如果您想要求修改或添加软件包,请通过 [Canva 开发者社区](https://community.canva.dev/)。 。 。 .

## 许可证

见 `LICENSE.md` 文档.

## 常见问题

### @canva/user 是什么？

Canva 开发者 SDK 用于 Canva 内部应用的用户库

### 如何安装 @canva/user？

在项目目录运行 npm install @canva/user，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@canva/error（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @canva/user 支持 TypeScript 吗？

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

### @canva/user 支持 ESM 还是 CommonJS？

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

### @canva/user 可以商用吗？

@canva/user 使用 SEE LICENSE IN LICENSE\.md FILE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @canva/user 的下载量有多少？

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

### @canva/user 还在维护吗？

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