Skip to content

Interface: ArraySchema<T>

A schema representing a return value or object property that is an array (list) of items. The items are themselves schema definitions, which may refer to scalars or other objects.

Extends

  • BaseSchema

Type Parameters

Type Parameter Default type
T extends Schema Schema

Properties

description?

optional description: string

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

Inherited from

BaseSchema.description


items

items: T

A schema for the items of this array.


type

type: Array

Identifies this schema as an array.