Skip to main content

Interface: DefaultParameter

Extends​

  • JsonSchema

Properties​

$comment?​

optional $comment: string

Comment string.

Inherited from​

JsonSchema.$comment

Defined in​

JsonSchema.ts:25

$defs?​

optional $defs: object

Object definitions.

Inherited from​

JsonSchema.$defs

Defined in​

JsonSchema.ts:23

$ref?​

optional $ref: string

Reference to object definitions.

Inherited from​

JsonSchema.$ref

Defined in​

JsonSchema.ts:21

$schema?​

optional $schema: string

Dialect of JSON Schema.

Inherited from​

JsonSchema.$schema

Defined in​

JsonSchema.ts:27

default​

default: any

Default value for the game parameter.

Overrides​

JsonSchema.default

Defined in​

GameParameters.ts:17

description?​

optional description: string

Description of the schema.

Inherited from​

JsonSchema.description

Defined in​

JsonSchema.ts:11

enum?​

optional enum: unknown[]

Values the schema can have.

Inherited from​

JsonSchema.enum

Defined in​

JsonSchema.ts:5

format?​

optional format: string

Annotation to indicate the type of string value, e.g., "date-time" or "email".

Inherited from​

JsonSchema.format

Defined in​

JsonSchema.ts:7

items?​

optional items: JsonSchema

If the value is an array, the array items in JsonSchema.

Inherited from​

JsonSchema.items

Defined in​

JsonSchema.ts:17

properties?​

optional properties: object

If the value is an object, the properties in JsonSchema.

Index Signature​

[key: string]: JsonSchema

Inherited from​

JsonSchema.properties

Defined in​

JsonSchema.ts:13

required?​

optional required: string[]

Required properties.

Inherited from​

JsonSchema.required

Defined in​

JsonSchema.ts:19

title?​

optional title: string

Intent of the schema.

Inherited from​

JsonSchema.title

Defined in​

JsonSchema.ts:9

type?​

optional type: JsonSchemaDataType | JsonSchemaDataType[]

Data type of the value or array of acceptable data types.

Inherited from​

JsonSchema.type

Defined in​

JsonSchema.ts:3