Interface INumber

Number (double) type info.

interface INumber {
    default?: number;
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    maximum?: number;
    minimum?: number;
    multipleOf?: number;
    readOnly?: boolean;
    title?: string;
    type: "number";
    writeOnly?: boolean;
}

Hierarchy (View Summary)

Properties

default? deprecated? description? example? examples? exclusiveMaximum? exclusiveMinimum? maximum? minimum? multipleOf? readOnly? title? type writeOnly?

Properties

Optionaldefault

default?: number

Default value of the number type.

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

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

OptionalreadOnly

readOnly?: boolean

Whether the property is read-only.

Optionaltitle

title?: string

Title of the schema.

type

type: "number"

Discriminator value of the type.

OptionalwriteOnly

writeOnly?: boolean

Whether the property is write-only.

Settings

Member Visibility

On This Page

Properties