fluid-oas
    Preparing search index...

    Interface OpenApiInteger

    A Integer representation of the JSON number schema.

    interface OpenApiInteger {
        addDefault(val: number): this;
        addDescription(description: string): this;
        addEnums(val: (null | number)[]): this;
        addExample(example: any): this;
        addExclusiveMax(max: number): this;
        addExclusiveMax(max: boolean): this;
        addExclusiveMin(min: number): this;
        addExclusiveMin(min: boolean): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addExternalDocs(docs: OpenApiDocumentation): this;
        addFormat(val: "int32" | "int64"): this;
        addMaximum(max: number): this;
        addMinimum(min: number): this;
        addMultiple(multipleOf: number): this;
        addNullable(nullable: boolean): this;
        addReadOnly(readOnly: boolean): this;
        addWriteOnly(writeOnly: boolean): this;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • OpenApiBaseNumber
      • OpenApiInteger
    Index

    Methods

    addDefault addDescription addEnums addExample addExclusiveMax addExclusiveMin addExtensions addExternalDocs addFormat addMaximum addMinimum addMultiple addNullable addReadOnly addWriteOnly override toJSON

    Methods

    • Parameters

      • val: number

      Returns this

    • Adds a description to this OpenApiSchema

      Parameters

      • description: string

        Description

      Returns this

    • Parameters

      • val: (null | number)[]

      Returns this

    • Parameters

      • example: any

      Returns this

    • Adds an exclusive maximum to this number.

      As of OpenApi v3.1.* exclusiveMax is now a number not a boolean.

      Parameters

      • max: number

        Maximum bound for this number.

      Returns this

    • Parameters

      • max: boolean

      Returns this

    • Adds an exclusive minimum to this number.

      As of OpenApi v3.1.* exclusiveMin is now a number not a boolean.

      Parameters

      • min: number

        Minimum bound for this number.

      Returns this

    • Parameters

      • min: boolean

      Returns this

    • Extend the specification with an extension object schema.

      Parameters

      • mappings: { [key: `x-${string}`]: OpenApiSchema }

        key value mappings with names MUST beginning with "x-"

      Returns this

    • Adds a maximum to this number schema.

      Parameters

      • max: number

        Maximum bound for this number.

      Returns this

    • Adds a minimum to this number schema.

      Parameters

      • min: number

        Minimum bound for this number.

      Returns this

    • Adds a multiple to validate numbers against.

      Parameters

      • multipleOf: number

        Constrain numbers to be multiples of the given value.

      Returns this

    • As of v3.1.0 this has been removed. Still available for v3.0.* OAS

      Parameters

      • nullable: boolean

      Returns this

    • Parameters

      • readOnly: boolean

      Returns this

    • Parameters

      • writeOnly: boolean

      Returns this

    • Overrides the toJSON method for a custom serialization.

      WARNING: overrideVal must be serializable and future changes are subject to breaking.

      Parameters

      • overrideVal: unknown

        Overrides the serialization of this object into this value.

      Returns this

    • Serializes the object into its equivalent OpenApi JSON value.

      Returns unknown

    Settings

    Member Visibility

    On This Page

    Methods