首页 > 解决方案 > 您如何访问环回模型属性类型?(model.definition.properties.type)

问题描述

如何从模型扩展文件 (model.js) 中访问模型属性类型?

如果我尝试访问 MODEL.definition.properties,我可以看到给定属性的以下内容:

{ type: [Function: String],
[1]   required: false,
[1]   description: 'deal stage' }

为什么列出的类型[Function: String]不仅仅是“字符串”或类似的东西?

如果我运行typeof(property.type)它返回“函数”,但如果我运行property.type()它返回一个空字符串。

标签: javascripttypesloopbackjs

解决方案


免责声明:我是 LoopBack 的合著者和当前维护者。

TL;博士

使用以下表达式以字符串名称的形式获取属性类型。请注意,它仅适用于可能的属性定义的子集(见下文),最值得注意的是它不支持数组。

const type = typeof property.type === 'string' 
  ? property.type
  : property.type.modelName || property.type.name;

长版

LoopBack 允许以多种方式定义属性类型:

  1. 作为字符串名称,例如{type: 'string', description: 'deal stage'}. 您也可以使用模型名称作为类型,例如{type: 'Customer'}
  2. 作为类型构造函数,例如{type: String, description: 'deal stage'}. 您也可以使用模型构造函数作为类型,例如{type: Customer}.
  3. 作为匿名模型的定义,例如{type: {street: String, city: String, country: String}
  4. 作为数组类型。可以使用上述三种方式中的任何一种来指定数组项的类型(作为字符串名称、类型构造函数或匿名模型定义)。

在我们的文档中阅读更多内容:LoopBack 类型

为了更好地理解如何处理不同类型的属性定义,您可以查看 loopback-swagger 中将 LoopBack 模型模式转换为 Swagger Schema(类似于 JSON Schema)的代码:

该函数在输入上getLdlTypeName接受一个属性定义(由 稍微标准化buildFromLoopBackType),并将属性类型作为字符串名称返回。

exports.getLdlTypeName = function(ldlType) {
  // Value "array" is a shortcut for `['any']`
  if (ldlType === 'array') {
    return ['any'];
  }

  if (typeof ldlType === 'string') {
    var arrayMatch = ldlType.match(/^\[(.*)\]$/);
    return arrayMatch ? [arrayMatch[1]] : ldlType;
  }

  if (typeof ldlType === 'function') {
    return ldlType.modelName || ldlType.name;
  }

  if (Array.isArray(ldlType)) {
    return ldlType;
  }

  if (typeof ldlType === 'object') {
    // Anonymous objects, they are allowed e.g. in accepts/returns definitions
    // TODO(bajtos) Build a named schema for this anonymous object
    return 'object';
  }

  if (ldlType === undefined) {
    return 'any';
  }

  var msg = g.f('Warning: unknown LDL type %j, using "{{any}}" instead', ldlType);
  console.error(msg);
  return 'any';
};

推荐阅读