Interface: ApiMessage
Defined in: envelope/index.ts:30
A single message under a modern errorformat (an entry of the errors or
warnings array). Which text-bearing field is present depends on the
format: text for plaintext/wikitext, html for html, key/params
for raw.
Properties
code
code:
string
Defined in: envelope/index.ts:32
Machine-readable code, e.g. badvalue, unrecognizedparams.
data?
optionaldata?:unknown
Defined in: envelope/index.ts:50
Extra structured data some messages attach.
html?
optionalhtml?:string
Defined in: envelope/index.ts:38
Parsed message HTML (errorformat=html).
key?
optionalkey?:string
Defined in: envelope/index.ts:41
i18n message key (errorformat=raw).
module?
optionalmodule?:string
Defined in: envelope/index.ts:47
Module the message originated from, e.g. main, query+info.
params?
optionalparams?:ApiMessageParam[]
Defined in: envelope/index.ts:44
i18n message parameters (errorformat=raw).
text?
optionaltext?:string
Defined in: envelope/index.ts:35
Rendered message (errorformat=plaintext/wikitext).