Interface DocPType<T, I>

A OpenAPI-compliant version of a GNPType. Depending on the PTOpts.type of the the PType, some properties may or may not appear.

Examples

// Type(S:Sex:Text)"
{
    "type": "string",
    "enum": ["M","F","I"]
};
// "Type(S:MD5)"
{
    "type": "string",
    "pattern": "/^[A-Fa-f0-9]+$/"
};
// "Type(N@:Int:>1)"
{
    "type": "array",
    "items": {
        "type": "integer",
        "minimum": 1
    },
    "minItems": 0,
    "maxItems": 2
};

Type parameters

T: TPDocPrims
I: boolean

Hierarchy

DocPType

Index

Properties

Properties

type

type: T

see: PTOpts.type

Optional format

format: T extends "number" | "integer" ? "int32" | "int64" | "float" | "double" : T extends "string" ? "byte" | "binary" | "date" | "date-time" | "password" : never

see: PTArgs.hidden

Optional enum

enum: Array<string | object>

see: PTArgs.selects

Optional pattern

pattern: T extends "string" ? string : never

see: PTArgs.regex

Optional minimum

minimum: T extends "number" | "integer" ? number : never

see: PTArgs.min

Optional maximum

maximum: T extends "number" | "integer" ? number : never

see: PTArgs.max

Optional multipleOf

multipleOf: T extends "number" | "integer" ? number : never

see: PTArgs.step

Optional items

items: I extends true ? DocPType<T, I>[] : never

For OpenAPI documentation purposes.

Optional minItems

minItems: I extends true ? number : never

see: PTArgs.slice

Optional maxItems

maxItems: I extends true ? number : never

see: PTArgs.slice