> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt.

# Interface: ApiMessageParamSpec

Defined in: [envelope/index.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L79)

Object form of a raw-format message parameter. Exactly one spec kind is
present at runtime: a nested message
(`message`), pre-escaped text (`plaintext`), raw text (`raw`), a number
(`num`), a duration in seconds (`duration`/`period`), an expiry (`expiry`),
a date/time (`datetime`/`date`/`time`), a user group (`group`), a byte size
(`size`), a bit rate (`bitrate`), the deprecated object form (`object`), or a
list (`list` + `type`).

## Properties

### bitrate?

> `optional` **bitrate?**: `number`

Defined in: [envelope/index.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L117)

Bit rate in bit/s.

***

### date?

> `optional` **date?**: `string`

Defined in: [envelope/index.ts:105](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L105)

Date.

***

### datetime?

> `optional` **datetime?**: `string`

Defined in: [envelope/index.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L102)

Date and time.

***

### duration?

> `optional` **duration?**: `number`

Defined in: [envelope/index.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L93)

Duration in seconds, rendered in full.

***

### expiry?

> `optional` **expiry?**: `string`

Defined in: [envelope/index.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L99)

Expiry timestamp, or `infinity`.

***

### group?

> `optional` **group?**: `string`

Defined in: [envelope/index.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L111)

User group name.

***

### list?

> `optional` **list?**: [`ApiMessageParam`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md)\[] | `Record`\<`string`, [`ApiMessageParam`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md)>

Defined in: [envelope/index.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L131)

Parameter items, when the parameter is a list. Serialized as an array
from MediaWiki 1.43 on; earlier versions keep the input array's keys, so
a non-contiguous list comes back as an object.

***

### message?

> `optional` **message?**: [`ApiRawMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiRawMessage.md)

Defined in: [envelope/index.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L81)

The parameter, when it is itself a message.

***

### num?

> `optional` **num?**: `number`

Defined in: [envelope/index.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L90)

Numeric parameter.

***

### ~~object?~~

> `optional` **object?**: `string`

Defined in: [envelope/index.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L124)

Object parameter, serialized as the object's string value.

#### Deprecated

since MediaWiki 1.43; removed in 1.44.

***

### period?

> `optional` **period?**: `number`

Defined in: [envelope/index.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L96)

Duration in seconds, rendered abbreviated.

***

### plaintext?

> `optional` **plaintext?**: `string`

Defined in: [envelope/index.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L84)

Pre-escaped parameter text.

***

### raw?

> `optional` **raw?**: `string`

Defined in: [envelope/index.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L87)

Raw parameter text, inserted after formatting.

***

### size?

> `optional` **size?**: `number`

Defined in: [envelope/index.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L114)

Size in bytes.

***

### time?

> `optional` **time?**: `string`

Defined in: [envelope/index.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L108)

Time.

***

### type?

> `optional` **type?**: `string` & `object` | `"comma"` | `"semicolon"` | `"pipe"` | `"text"`

Defined in: [envelope/index.ts:134](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L134)

Rendering type of the [ApiMessageParamSpec.list](#list) items. Open union for forward compatibility.