Nohm 技术文档

本文档将详细介绍如何安装、使用以及 API 调用 Nohm，一个为 node.js 和 redis 编写的对象关系映射器（ORM），采用 TypeScript 语言开发。

1. 安装指南

在开始使用 Nohm 前，请确保您已安装了 Node.js 以及 Redis。Redis 的版本需要大于等于 2.4。

通过 npm 安装 Nohm：

npm install --save nohm

2. 项目使用说明

Nohm 提供了标准 ORM 功能，包括验证、存储、搜索、排序、链接/取消链接以及删除等。以下是一个使用 Nohm 的简单示例。

定义模型

首先，定义一个模型，例如 UserModel，并设置模型名称和属性定义。

class UserModel extends Model {
  static modelName = 'User';
  static definitions = {
    email: {
      type: 'string',
      unique: true,
      validations: ['email'],
    },
    country: {
      type: 'string',
      defaultValue: 'Narnia',
      index: true,
      validations: [
        async function checkCountryExists(value) {
          return existingCountries.includes(value);
        },
        { name: 'length', options: { min: 3 } },
      ],
    },
    visits: {
      type: function incrVisitsBy(value, key, old) {
        return parseInt(old, 10) + parseInt(value, 10);
      },
      defaultValue: 0,
      index: true,
    },
  };
}

注册模型并连接 Redis

注册模型并设置 Redis 客户端。

const UserModelClass = nohm.register(UserModel);
const redis = require('redis').createClient();
redis.on('connect', async () => {
  nohm.setClient(redis);
  // 后续操作...
});

创建和保存数据

创建一个新的模型实例并设置属性。

const user = await nohm.factory('User');
user.property({
  email: '[e-mail]',
  country: 'Gondor',
  visits: 1,
});

try {
  await user.save();
} catch (err) {
  if (err instanceof ValidationError) {
    // 处理验证错误
  }
  throw err;
}

加载数据

通过 ID 加载数据。

const loadedUser = await UserModelClass.load(id);

更新数据

更新数据属性。

const newVisits = loadedUser.property('visits', 20);

删除数据

删除数据。

await loadedUser.remove();

3. 项目 API 使用文档

Nohm 的 API 文档可以在其官方 GitHub 页面找到。以下是部分 API 的简单介绍：

• Nohm.factory(modelName, [id]): 创建一个新的模型实例或加载现有的实例。
• Nohm.register(ModelClass): 注册一个新的模型类。
• ModelClass.load(id): 根据给定的 ID 加载一个模型实例。
• ModelClass.findAndLoad(conditions): 根据给定的条件搜索并加载模型实例。

更多 API 信息，请参考 Nohm 的官方文档。

4. 项目安装方式

Nohm 可以通过 npm 进行安装。确保您已安装了最新版本的 npm，然后运行以下命令：

npm install --save nohm

以上就是关于 Nohm 的技术文档，希望对您有所帮助。