@hapipal/schwifty

中文文档
6.2.0发布于 2022/11/28MITCommonJS近 30 天下载 7531

A model layer for hapi integrating Objection ORM

原始使用文档
文档目录3 节
  1. Installation
  2. Usage
  3. Extras

schwifty

A model layer for hapi integrating Objection ORM

Build Status Coverage Status

Lead Maintainer - Devin Ivy

Installation

npm install @hapipal/schwifty

Usage

See also the API Reference

Schwifty is intended for use with hapi v19+, nodejs v12+, Joi v17+, Objection v1 through v3, and knex v0.16+ (see v5 for lower support).

Schwifty is used to define Joi-compatible models and knex connections for use with Objection ORM. Those models then become available within your hapi server where it is most convenient. It has been tailored to multi-plugin deployments, where each plugin may set clear boundaries in defining its own models, knex database connections, and migrations. It's safe to register schwifty multiple times, wherever you'd like to use it, as it protects against model name collisions and other ambiguous configurations.

// First, ensure your project includes knex, objection, and sqlite3

// To get started you might run,
// npm install --save @hapipal/schwifty @hapi/hapi joi knex objection sqlite3

'use strict';

const Hapi = require('@hapi/hapi');
const Schwifty = require('@hapipal/schwifty');
const Joi = require('joi');

(async () => {

    const server = Hapi.server({ port: 3000 });

    server.route({
        method: 'get',
        path: '/dogs/{id}',
        handler: async (request) => {

            const { Dog } = request.models();

            return await Dog.query().findById(request.params.id);
        }
    });

    await server.register({
        plugin: Schwifty,
        options: {
            knex: {
                client: 'sqlite3',
                useNullAsDefault: true,
                connection: {
                    filename: ':memory:'
                }
            }
        }
    });

    // Register a model with schwifty...

    server.registerModel(
        class Dog extends Schwifty.Model {
            static tableName = 'Dog';
            static joiSchema = Joi.object({
                id: Joi.number(),
                name: Joi.string()
            });
        }
    );

    await server.initialize();

    // ... then make a table ...

    const knex = server.knex();

    await knex.schema.createTable('Dog', (table) => {

        table.increments('id').primary();
        table.string('name');
    });

    // ... then add some records ...

    const { Dog } = server.models();

    await Promise.all([
        Dog.query().insert({ name: 'Guinness' }),
        Dog.query().insert({ name: 'Sully' }),
        Dog.query().insert({ name: 'Ren' })
    ]);

    // ... then start the server!

    await server.start();

    console.log(`Now, go find some dogs at ${server.info.uri}`);
})();

Extras

版本与发布记录

@hapipal/schwifty 共发布 5 个版本,首次发布于 2020/11/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
6.2.0latest2022/11/283 年前
6.2.0-types.1types2022/03/134 年前
6.2.0-types.02022/03/134 年前
6.1.02021/11/145 年前
6.0.02020/11/116 年前

关于 @hapipal/schwifty 的常见问题

@hapipal/schwifty 是什么?

A model layer for hapi integrating Objection ORM

如何安装 @hapipal/schwifty?

在项目目录运行 npm install @hapipal/schwifty,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@hapi/hapi(>=19 <22)、joi(>=17 <18)、knex(>=0.16)、objection(>=1 <4)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@hapipal/schwifty 支持 TypeScript 吗?

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

@hapipal/schwifty 支持 ESM 还是 CommonJS?

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

@hapipal/schwifty 需要什么版本的 Node.js?

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

@hapipal/schwifty 可以商用吗?

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

@hapipal/schwifty 的下载量有多少?

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

@hapipal/schwifty 还在维护吗?

最新版本 6.2.0 发布于 2022/11/28(3 年前);至今共发布 5 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/11/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。