Interface IInteger

Integer type schema info.

interface IInteger {
    default?: null | number;
    deprecated?: boolean;
    description?: string;
    enum?: (null | number)[];
    example?: any;
    examples?: Record<string, any>;
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    maximum?: number;
    minimum?: number;
    multipleOf?: number;
    nullable?: boolean;
    title?: string;
    type: "integer";
}

Hierarchy (View Summary)

Properties

default? deprecated? description? enum? example? examples? exclusiveMaximum? exclusiveMinimum? maximum? minimum? multipleOf? nullable? title? type

Properties

Optionaldefault

default?: null | number

Default value.

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalenum

enum?: (null | number)[]

Enumeration values.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

OptionalexclusiveMaximum

exclusiveMaximum?: number

Exclusive maximum value restriction.

OptionalexclusiveMinimum

exclusiveMinimum?: number

Exclusive minimum value restriction.

Optionalmaximum

maximum?: number

Maximum value restriction.

Optionalminimum

minimum?: number

Minimum value restriction.

OptionalmultipleOf

multipleOf?: number

Multiple of value restriction.

Exclusive Minimum

0

Optionalnullable

nullable?: boolean

Whether to allow null value or not.

Optionaltitle

title?: string

Title of the schema.

type

type: "integer"

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties