如何用typescript和ajv使oneOf字段可空

Question

我有一个名为＜code＞platform＜/code＞的字段，它可以是＜code＞字符串＜/code＞或＜code＞字符串〔〕

打字接口

export interface IEntityLeaderboardQuery {
    rank: string;
    entity_types: string[] | string;
    country?: string | undefined;
    region?: string | undefined;
    start_date: string;
    end_date: string;
    top?: string | undefined;
    platform?: string[] | string | undefined;
}

json模式

export const EntityLeaderboardQuerySchema: JSONSchemaType<IEntityLeaderboardQuery> = {
    type: "object",
    properties: {
        rank: { type: "string" },
        entity_types: {
            oneOf: [
                {
                    type: "string",
                },
                {
                    type: "array",
                    items: { type: "string" },
                },
            ],
        },
        country: { type: "string", nullable: true },
        region: { type: "string", nullable: true },
        start_date: { type: "string" },
        end_date: { type: "string" },
        top: { type: "string", nullable: true },
        platform: {
            oneOf: [
                {
                    type: "string",
                    nullable: true,
                },
                {
                    type: "array",
                    items: { type: "string" },
                    nullable: true,
                },
            ],
        },
    },
    required: ["rank", "entity_types", "start_date", "end_date"],
    additionalProperties: false,
};

如你所见，我试图在oneOf数组中给两个对象都添加可空字段。然而，类型仍然存在一个问题

[错误] 11：07：49 ⨯ 无法编译 TypeScript： src/api/leaderboard/entity/entity-leaderboard.interface.ts：43：14 - 错误 TS2322： 键入 '{ 类型： “object”; 属性： { rank： { type： “string”; }; entity_types： { oneOf： （{ type： “string”; } |{ type： “array”; items： { type： “string”; }; }）[];};国家： { 类型： “字符串”; 可为 null： true; };region： { ...; };start_date： { ...; };end_date： { ...; };顶部： { ...; };平台： { ...; };};必需：（“ra...”）不可分配给类型 'UncheckedJSONSchemaType

43 export const EntityLeaderboardQuerySchema： JSONSchemaType = {

ajv: 8.6.2
typescipt: 4.3.5

https://replit.com/join/ngjynszvjr-kaykhan

Answer 1

出现问题是因为您将< code>nullable: true赋值给< code>oneOf的项，您必须指定outside，因为该属性使用可选的链接< code >？ 平台:string[] | string

platform: {
  nullable: true, //<-- nullable Here
  type: ['string', 'array'], //<-- when using "nullable" you must specify the types
  oneOf: [
    { 
      type: 'string' 
    },
    {
      type: 'array',
      items: { type: 'string' },
    }
  ]
}

如果您将严格模式与 Ajv 一起使用，您可能会收到警告：

strict mode: use allowUnionTypes to allow union type keyword at "#/properties/platform" (strictTypes)

启用＜code＞allowUnionTypes＜/code＞应该可以工作：

const ajv = new Ajv({ allowUnionTypes: true })

Answer 2

我也遇到过类似的情况，这对我很有帮助：

oneOf: [
    {
        type: "string",
    },
    {
        type: "array",
        items: { type: "string" },
    },
    {
        type: "object",
        nullable: true,
    },
],

使用＜code＞｛type:‘null｝＜/code＞不起作用。