如何在枚举中声明字符串

时间:2018-05-11 22:15:45

标签: graphql graphql-js

使用graphql,enum可以生成预定义的元素列表,但字符串不起作用。

例如:

enum Dias {
  lunes
  martes
  miércoles
  jueves
  viernes
  sábado
  domingo
}

这会返回错误GraphQLError: Syntax Error: Cannot parse the unexpected character "\u00E9".

如何制作预定义的字符串列表?

编辑:为了提供更多上下文,我想反映数据库架构,就像这样(用mongoose):

dias: {
  type: String,
  enum: ['lunes', 'martes', 'miércoles', 'jueves', 'viernes', 'sábado', 'domingo'],
  lowercase: true,
  required: true
}

1 个答案:

答案 0 :(得分:6)

您的语法是正确的,唯一的问题是不支持“é”和“á”字符。 specification概述了命名操作,字段等规则。支持的模式是:

/[_A-Za-z][_0-9A-Za-z]*/

此外:

  

GraphQL中的名称仅限于此可能字符的ASCII子集,以支持与尽可能多的其他系统进行互操作。

所以,遗憾的是,您必须将这些重音字符转换为有效字符才能使您的模式有效。

编辑:您可以创建自定义标量。这是一个带有名称,描述和数组并返回自定义标量的函数:

const makeCustomEnumScalar = (name, description, validValues) => {
  const checkValue = (value) => {
    const coerced = String(value)
    if (!validValues.includes(coerced)) {
      throw new TypeError(`${coerced} is not a valid value for scalar ${name}`)
    }
    return coerced  
  }
  return new GraphQLScalarType({
    name,
    description,
    serialize: checkValue,
    parseValue: checkValue,
    parseLiteral: (ast) => checkValue(ast.value),
  })
}

现在您可以执行以下操作:

const DayOfWeek = makeCustomEnumScalar('Day of Week', 'day of week enum', [
  'lunes',
  'martes',
  'miércoles',
  'jueves',
  'viernes',
  'sábado',
  'domingo'
])

将其添加到您的解析器:

const resolvers = {
  DayOfWeek,
  // Query, Mutation, etc.
}

您的类型定义:

scalar DayOfWeek

然后你可以像任何其他标量一样使用它。如果查询提供了无效值作为输入或输出,则GraphQL将抛出与枚举类似的错误。唯一需要注意的是,如果你直接在查询中输入值(而不是使用变量),你仍然需要用双引号将它们包装起来。