Class NumberSchema

Schema class for "number" types.

Hierarchy (View Summary)

Schema
- NumberSchema

Indexable

[key: string]: unknown
Allows user to add other schema properties that have not yet been officially added to the SDK.

Index

Constructors

constructor

new NumberSchema(schemaParams?: SchemaParams): NumberSchema
Parameters
- OptionalschemaParams: SchemaParams
Returns NumberSchema
Overrides Schema.constructor
- Defined in requests/schema-builder.ts:162

Methods

toJSON

toJSON(): SchemaRequest
Internal
Defines how this Schema should be serialized as JSON. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#tojson_behavior

Returns SchemaRequest
Inherited from Schema.toJSON
- Defined in requests/schema-builder.ts:82

`Static`array

array(arrayParams: SchemaParams & { items: Schema }): ArraySchema
Parameters
- arrayParams: SchemaParams & { items: Schema }
Returns ArraySchema
Inherited from Schema.array
- Defined in requests/schema-builder.ts:96

`Static`boolean

boolean(booleanParams?: SchemaParams): BooleanSchema
Parameters
- OptionalbooleanParams: SchemaParams
Returns BooleanSchema
Inherited from Schema.boolean
- Defined in requests/schema-builder.ts:127

`Static`enumString

enumString(stringParams: SchemaParams & { enum: string[] }): StringSchema
Parameters
- stringParams: SchemaParams & { enum: string[] }
Returns StringSchema
Inherited from Schema.enumString
- Defined in requests/schema-builder.ts:115

`Static`integer

integer(integerParams?: SchemaParams): IntegerSchema
Parameters
- OptionalintegerParams: SchemaParams
Returns IntegerSchema
Inherited from Schema.integer
- Defined in requests/schema-builder.ts:119

`Static`number

number(numberParams?: SchemaParams): NumberSchema
Parameters
- OptionalnumberParams: SchemaParams
Returns NumberSchema
Inherited from Schema.number
- Defined in requests/schema-builder.ts:123

`Static`object

object(
    objectParams: SchemaParams & {
        optionalProperties?: string[];
        properties: { [k: string]: Schema };
    },
): ObjectSchema
Parameters
- objectParams: SchemaParams & {
  optionalProperties?: string[];
  properties: { [k: string]: Schema };
  }
Returns ObjectSchema
Inherited from Schema.object
- Defined in requests/schema-builder.ts:100

`Static`string

string(stringParams?: SchemaParams): StringSchema
Parameters
- OptionalstringParams: SchemaParams
Returns StringSchema
Inherited from Schema.string
- Defined in requests/schema-builder.ts:111

Properties

`Optional`description

description?: string

Optional. The description of the property.

`Optional`example

example?: unknown

Optional. The example of the property.

`Optional`format

format?: string

Optional. The format of the property. Supported formats:

for NUMBER type: "float", "double"
for INTEGER type: "int32", "int64"
for STRING type: "email", "byte", etc

`Optional`items

items?: SchemaInterface

Optional. The items of the property.

`Optional`maxItems

maxItems?: number

The maximum number of items (elements) in a schema of type SchemaType.ARRAY.

`Optional`minItems

minItems?: number

The minimum number of items (elements) in a schema of type SchemaType.ARRAY.

nullable

nullable: boolean

Optional. Whether the property is nullable. Defaults to false.

type

type: SchemaType

Optional. The type of the property. SchemaType.

Class NumberSchema

Hierarchy (View Summary)

Indexable

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns NumberSchema

Methods

toJSON

Returns SchemaRequest

Staticarray

Parameters

Returns ArraySchema

Staticboolean

Parameters

Returns BooleanSchema

StaticenumString

Parameters

Returns StringSchema

Staticinteger

Parameters

Returns IntegerSchema

Staticnumber

Parameters

Returns NumberSchema

Staticobject

Parameters

Returns ObjectSchema

Staticstring

Parameters

Returns StringSchema

Properties

Optionaldescription

Optionalexample

Optionalformat

Optionalitems

OptionalmaxItems

OptionalminItems

nullable

type

Settings

On This Page

`Static`array

`Static`boolean

`Static`enumString

`Static`integer

`Static`number

`Static`object

`Static`string

`Optional`description

`Optional`example

`Optional`format

`Optional`items

`Optional`maxItems

`Optional`minItems