npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@galenjs/models

v1.7.1-alpha.0

Published

galenjs models

Downloads

10

Readme

models

  • galen模型数据处理中心

Usage

const loadModels = require('@galenjs/models')
const path = require('path')

const bootstrap = async () => {
  const {
    remoteMethods, modelDefs, jsonSchemas, dataSources, models
  } = await loadModels({
    workspace: process.cwd(),
    modelPath: './models',
    modelDefPath: './modelDefs',
    datasources: {
      main: {
        dataSource: 'sequelize',
        options: {
          host: '127.0.0.1',
          user: 'root',
          password: 'alfieri',
          database: 'test'
        }
      },
      virtual: {
        dataSource: 'virtual',
        options: {}
      }
    }
  })
}

bootstrap()

dataSource

数据源

例如

dataSource: 'main'

tags

背景: 支持influx

模型标签-influx

例如

tags: ['host']

tableName

默认创建的表名

例如

tableName: 't_user'

modelName

默认模型名

例如

modelName: 'User'

dialect

默认使用的是sequelize

  • sequelize
  • virtual-虚拟模型类型(不创建任何模型)
  • influx

例如

dialect: 'mysql'

properties

模型属性

例如

properties:
  id:
    type: integer
    autoIncrement: true
    primaryKey: true
  phone:
    type: string
    length: 11
    description: '手机号'
  password:
    type: string
    length: 32
    description: '密码'
  nickName:
    type: string
    length: 32
    description: '昵称'
  createdAt:
    type: date
    allowNull: false
  updatedAt:
    type: date
    allowNull: false
  deletedAt:
    type: date
    allowNull: false

relations

关联关系

  • belongsTo
relations:
  role:
    type: 'belongsTo'
    model: 'Role'
  • hasOne

  • hasMany

relations:
  roles:
    type: 'hasMany'
    model: 'Role'
  • belongsToMany
relations:
  roles:
    type: 'belongsToMany'
    model: 'Role'
    through: 'UserRole'

indexes

联合索引(支持的类型是index和unique,后续在考虑接入fulltext)

例如

indexes:
  testIndex:
    type: 'unique'
    fields:
      - phone
      - nickName

remoteMethods

接口请求信息

自定义接口信息,用来生成文档和api路由

例如

remoteMethods:
  register:
      path: '/register'
      method: 'post'
      tags:
        - user
      summary: '用户注册'
      requestBody:
        body:
          phone:
            type: string
            length: 11
            description: '手机号'
          password:
            type: string
            length: 32
            description: '密码'
        required:
          - phone
          - password
      output:
        200:
          type: 'object'
          result:
            id:
              type: integer
              autoIncrement: true
              primaryKey: true
            phone:
              type: string
              length: 11
              description: '手机号'
            password:
              type: string
              length: 32
              description: '密码'
            nickName:
              type: string
              length: 32
              description: '昵称'
            createdAt:
              type: date
              allowNull: false
            updatedAt:
              type: date
              allowNull: false
            deletedAt:
              type: date
              allowNull: false 

path

接口路径,可以默认添加prefix

responseType

数据返回类型

  1. origin - 不对结果进行处理

  2. normal - 返回标准开放API格式数据

{
  "code": 0,
  "message": "",
  "data": {}
}

method

接口方法,get,post,put,delete,patch,head

标签接口分类tags

例如

tags:
  - user

接口描述-summary

query

请求query参数 例如

query:
  filter:
    type: string
    description: '查询参数'

requestBody

请求体 例如

requestBody:
  body:
    phone:
      type: string
      length: 11
      description: '手机号'
    password:
      type: string
      length: 32
      description: '密码'
  required:
    - phone
    - password

params

例如

query:
  id:
    type: string
    description: 'id'

output

返回结果 例如

output:
  200:
    type: 'object'
    result:
      id:
        type: integer
        autoIncrement: true
        primaryKey: true
      phone:
        type: string
        length: 11
        description: '手机号'
      password:
        type: string
        length: 32
        description: '密码'
      nickName:
        type: string
        length: 32
        description: '昵称'
      createdAt:
        type: date
        allowNull: false
      updatedAt:
        type: date
        allowNull: false
      deletedAt:
        type: date
        allowNull: false 

output支持model 例如

output:
  200:
    type: 'object'
    model: 'User'