RecordOf

@tsed/schema

Usage

import { RecordOf } from "@tsed/schema";

See /packages/specs/schema/src/types/decorators/common/recordOf.ts.

Overview

function RecordOf(model: any, ...keys: string[]): (...args: any[]) => any;

Description

Constructs a json schema object type whose property keys are keys and whose property values are type.

Example

type keys = 'one' | 'two';

class Part {
  prop: string;
}

type Parts = Record<keys, Part>;

class Test {
  @RecordOf(Part, 'one', 'two')
  parts: Parts;
}

Will produce:

{
    "type": "object",
    "properties": {
        "one": {
            "$ref": "#/components/schemas/Part"
        },
        "two": {
            "$ref": "#/components/schemas/Part"
        },
    },
}