# @bleskomat/form 中文文档

规范地址：https://npmcn.com/package/%40bleskomat/form/

版本：1\.3\.2
npm 元数据更新时间：2023-08-30T11:36:11.451Z
中文译文更新时间：2026-11-08T06:43:31.192Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：18.3 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2022-03-12T21:18:53.089Z
- 最新版本发布：2023-08-30T11:36:11.252Z
- 近 30 天下载量：3359（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

与验证(同步和同步),后处理,以及支持手提栏模板的节点.js的窗体类.

## 安装

```sh
npm install @bleskomat/form
```

也可以使用：`pnpm add @bleskomat/form`、`yarn add @bleskomat/form`、`bun add @bleskomat/form`

## README

# 窗体节点

![Build Status](https://github.com/bleskomat/form-node/actions/workflows/tests.yml/badge.svg)

与验证(同步和同步),后处理,以及支持手提栏模板的节点.js的窗体类.

-   [安装](https://npmcn.com/package/%40bleskomat/form/#readme-installation)
-   [使用量](https://npmcn.com/package/%40bleskomat/form/#readme-usage)
-   [测试](https://npmcn.com/package/%40bleskomat/form/#readme-tests)
-   [更改日志](https://npmcn.com/package/%40bleskomat/form/#readme-changelog)
-   [许可证](https://npmcn.com/package/%40bleskomat/form/#readme-license)

## 安装

通过 `npm`数字 :

```bash
npm install @bleskomat/form
```

## 使用量

用于 [快手栏](https://www.npmjs.com/package/express-handlebars)数字 :

```js
const bodyParser = require('body-parser');
const express = require('express');
const Form = require('@bleskomat/form');
const Handlebars = require('express-handlebars');
const path = require('path');
const { ValidationError } = Form;

const app = express();

const hbs = Handlebars.create({
    extname: '.html',
    helpers: Form.handlebars.helpers,
    partialsDir: [
        path.join(__dirname, 'views', 'partials'),
        Form.handlebars.partialsDir,
    ],
});

app.engine('.html', hbs.engine);
app.set('view engine', '.html');
app.set('views', path.join(__dirname, 'views'));
app.enable('view cache');

// Parse application/x-www-form-urlencoded:
app.use(bodyParser.urlencoded({ extended: false }));

const form = new Form({
    title: 'Form partial example',
    action: '/form',
    groups: [
        {
            name: 'login',
            inputs: [
                {
                    name: 'username',
                    label: 'Username',
                    required: true,
                    validate: function(value, data) {
                        // `value` contains the value submitted for this field.
                        // `data` is an object which contains all form data.
                        // Perform custom validations for this field here.
                        // Throw an error here to fail the validation.
                        // Optionally return an instance of Promise to perform asynchronous validation.
                    },
                    process: function(value) {
                        // `value` contains the value submitted for this field.
                        // Perform custom processing for this field's value.
                        return value;
                    },
                },
                {
                    name: 'password',
                    label: 'Password',
                    required: true,
                },
            ],
        },
    ],
});

app.get('/form', function(req, res, next) {
    res.render('form', {
        form: form.serialize(),
    });
});

app.post('/form', function(req, res, next) {
    // `req.body` is provided by the `bodyParser` middleware.
    form.validate(req.body).then(values => {
        // Validation successful.
        // `values` is an object which contains processed form data.
    }).catch(error => {
        if (error instanceof ValidationError) {
            res.status(400);
        } else {
            error = new Error('An unexpected error has occurred');
            res.status(500);
        }
        res.render('form', {
            form: form.serialize({
                errors: [ error.message ],
            }),
        });
    });
});
```

## 测试

运行自动测试如下:

```bash
npm test
```

## 更改日志

见 [变动情况](https://github.com/bleskomat/form-node/blob/master/CHANGELOG.md)

## 许可证

这个软件是 [麻省理工学院执照](https://tldrlegal.com/license/mit-license)数字 :

> 一个简短的,允许性的软件许可证. 基本上,只要在软件/源代码的任何副本中包含原始版权和许可证通知,就可以做任何你想做的事. 这种许可证的使用有许多不同之处.

## 常见问题

### @bleskomat/form 是什么？

与验证\(同步和同步\),后处理,以及支持手提栏模板的节点\.js的窗体类\.

### 如何安装 @bleskomat/form？

在项目目录运行 npm install @bleskomat/form，或使用 pnpm add / yarn add / bun add。

### @bleskomat/form 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bleskomat\_\_form 是否存在。

### @bleskomat/form 支持 ESM 还是 CommonJS？

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

### @bleskomat/form 可以商用吗？

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

### @bleskomat/form 的下载量有多少？

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

### @bleskomat/form 还在维护吗？

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