Interface INumber

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

Hierarchy (View Summary)

Properties

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

Properties

Optionaldefault

default?: null | number

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalenum

enum?: (null | number)[]

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: any[] | Record<string, any>

OptionalexclusiveMaximum

exclusiveMaximum?: number | boolean

OptionalexclusiveMinimum

exclusiveMinimum?: number | boolean

Optionalmaximum

maximum?: number

Optionalminimum

minimum?: number

OptionalmultipleOf

multipleOf?: number

Exclusive Minimum

0

Optionalnullable

nullable?: boolean

Optionaltitle

title?: string

Title of the schema.

type

type: "number"

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties