Other core types

boolean

A value that is either true or false, equivalent to boolean in JSON Schema.

Example

true

false

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: boolean.yaml
type: boolean

Array

An ordered list of values, equivalent to array in JSON Schema.

Formats

Example

[1, 2, 3]

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: array.yaml
type: array

Usage

In TypeSpec, you can specify the type of the values in the array with templating:

/** An array of integers */
alias IntegerArray = Array<integer>

This is equivalent to the following JSON Schema:

$id: IntegerArray.yaml
type: array
items:
  type: integer

Record

A collection of key-value pairs, equivalent to object in JSON Schema.

Formats

Example

{
  "foo": 1,
  "bar": 2
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: record.yaml
type: object

Usage

In TypeSpec, you can specify the type of the values in the record with templating:

/** A record with a string key and an integer value */
alias StringIntRecord = Record<integer>

This is equivalent to the following JSON Schema:

$id: StringIntRecord.yaml
type: object
additionalProperties:
  type: integer

If you want to define specific keys in a record, you can do so with a model.

null

The null type, equivalent to null in JSON Schema.

Example

null

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: null.yaml
type: null

unknown

The unknown type accepts any value. It is equivalent to an empty JSON Schema.

Example

All of the following are valid values for the unknown type:

// String
"foo"

// Integer
123

// Boolean
true

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: unknown.yaml