--- url: https://types-mediawiki-response.pages.dev/guide/getting-started.md --- > 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. # Getting started Type declarations for MediaWiki Action API responses, written for `formatversion=2` with a field union spanning 1.39–1.47. The package ships declarations only (`dist/*.d.ts`) — no runtime code, so importing it adds nothing to your bundle. ## Install ```sh [npm] npm install -D types-mediawiki-response ``` ```sh [yarn] yarn add -D types-mediawiki-response ``` ```sh [pnpm] pnpm add -D types-mediawiki-response ``` ```sh [bun] bun add -d types-mediawiki-response ``` ```sh [deno] deno add npm:types-mediawiki-response ``` ## Cast the response of an action Each `action` maps to one `ApiXxxResponse`. For example, fetching page revisions: ```ts import type { ApiQueryResponse } from "types-mediawiki-response"; const res = (await api.get({ action: "query", prop: "revisions", titles, formatversion: "2", })) as ApiQueryResponse; console.log(res.query.pages[0]?.revisions); ``` Pass `formatversion: "2"` on the request — the library's types cover fv2 only. Every response type is listed in the [API reference](https://types-mediawiki-response.pages.dev/api/index.md). ## Handling errors Casting to `ApiXxxResponse` only asserts **no root error** — which is not the same as "the operation succeeded". How to handle a failing response depends mainly on the client: - Clients that handle root errors for you, such as `mw.Api`, throw as soon as the response carries a root `error` / `errors` — just wrap the request in a `try`/`catch`, and no extra handling of the response type is needed. - Clients that hand the error response back as-is (native `fetch`, for example) need the type wrapped with [`ApiResponseWith`](https://types-mediawiki-response.pages.dev/api/core/ApiResponseWith.md) and a narrowing on `error` / `errors`. See [Envelope and error handling](https://types-mediawiki-response.pages.dev/guide/errors.md) for the details. ## Extensions Core types cover MediaWiki core modules only. Fields contributed by extensions are split into opt-in packs: a single type-only import in any file covered by your tsconfig activates the pack program-wide: ```ts // Activate the CheckUser extension import type {} from "types-mediawiki-response/ext/checkuser"; ``` A field that shows up in the real response but not in the core types usually means an extension provides it — that is your cue to activate its pack. An extension action (`action=thank`, `action=shortenurl`, …) instead exports a standalone response type — import it by name where you call it, like any core action response: ```ts import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks"; const res: ApiThankResponse = await api.post({ action: "thank", rev }); res.result?.recipient; // the thanked user ``` See [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md). ## Working with AI Besides the copy-Markdown feature at the top of each page, this docs site also publishes llms.txt files alongside its content: - [llms.txt](https://types-mediawiki-response.pages.dev/llms.txt): an index file with descriptions and links for every page on the site ``` https://types-mediawiki-response.pages.dev/llms.txt ``` - [llms-full.txt](https://types-mediawiki-response.pages.dev/llms-full.txt): the entire site content merged into one file ``` https://types-mediawiki-response.pages.dev/llms-full.txt ``` Copy whichever link fits your use case and hand it to your agent. ## Next steps - [Envelope and error handling](https://types-mediawiki-response.pages.dev/guide/errors.md) - [Query responses](https://types-mediawiki-response.pages.dev/guide/query.md) - [Field conventions](https://types-mediawiki-response.pages.dev/guide/conventions.md) - [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md) - [Examples](https://types-mediawiki-response.pages.dev/guide/examples.md) --- url: https://types-mediawiki-response.pages.dev/guide/errors.md --- > 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. # Envelope and error handling All response types model the **non-error response** — the payload returned when the request itself was not rejected. That is **not** the same as "the operation succeeded"; see [Root errors vs in-band failures](#root-errors-vs-in-band-failures) below. To express "may fail", wrap the corresponding `ApiXxxResponse` with [`ApiResponseWith`](https://types-mediawiki-response.pages.dev/api/core/ApiResponseWith.md) and narrow on `error` / `errors`: ```ts import type { ApiEditResponse, ApiResponseWith } from "types-mediawiki-response"; const res = (await api.post({ action: "edit" /* … */ })) as ApiResponseWith; if ("error" in res || "errors" in res) { // ApiErrorResponse — the request failed } else { res.edit; // success payload } ``` Which clients need this wrapper depends on how they surface errors. `mw.Api`, the stock in-wiki client, **rejects the promise** when the response carries a root `error` / `errors` — inside `try`/`catch`, casting straight to `ApiXxxResponse` is enough and the narrowing above is unnecessary. `ApiResponseWith` is for clients that resolve the error envelope as an ordinary value (a bare `fetch` wrapper, for example). In-band failures stay in the payload either way. ## Root errors vs in-band failures "Non-error response" is not the same as "the operation succeeded". Three cases: - **Root-level `error` / `errors`** — the request failed as a whole and carries no payload; the entire response is [`ApiErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiErrorResponse.md). This is the case `ApiResponseWith` narrows on. - **In-band failure** — the request was accepted but the operation failed. The payload is present, and the failure is an ordinary field of it — no `ApiResponseWith` involved, just check the field. Where the field lives depends on the module, for example: - `action=emailuser`: `res.emailuser.result` is `"Failure"`, with the reason inside `res.emailuser.errors[]`; - `action=tag`: `res.tag` is a per-target array; check the result status in `res.tag[i].status`; - `action=move`: `res.move.subpages` is either an array (partial failure) or an `{ errors }` object (the whole subpage move failed). - **`warnings`** — may appear on either envelope. So casting to `ApiXxxResponse` asserts "no root error", not "nothing went wrong". ## Two error formats The error/warning shape depends on the request's `errorformat`; both families are modeled: - **bc** (backwards-compatible, the default): a single top-level `error` object (`{ code, info, docref }`), and warnings as a `warnings` object keyed by module name; - **modern** (`plaintext` / `wikitext` / `html` / `raw` / `none`): a top-level `errors` array of [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md), warnings as an `ApiMessage[]` array, plus a top-level `docref`. The narrowing condition checks both `error` and `errors`, so it holds under either setting. ## Envelope fields [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) models the top-level fields that may appear on any response, successful or not: `batchcomplete`, `servedby`, `curtimestamp`, `requestid`, `warnings`. Every `ApiXxxResponse` already carries these fields; the error responses ([`ApiBcErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiBcErrorResponse.md) / [`ApiModernErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiModernErrorResponse.md)) extend them explicitly. --- url: https://types-mediawiki-response.pages.dev/guide/query.md --- > 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. # Query responses `action=query` is the most heavily used action, and its response is typed by composition: module results merge into shared interfaces, keyed by where the server puts them. ## The two landing spots - `query.pages[]`: the union of the page-level `prop=` modules. Each entry is an [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) that merges the fields of every covered `prop=` module. Which fields a page actually carries depends on the `prop=` you passed; the type is their union for convenience, yet wider than any single request, so fields you never asked for look available. - The `query` root: `list=` / `meta=` results, plus the occasional `prop=` whose result is not page-scoped (e.g. `prop=stashimageinfo` lands at `query.stashimageinfo`). They merge directly into [`ApiQueryResult`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md): `query.recentchanges` for `list=recentchanges`, `query.general` for `meta=siteinfo`, and so on. They do not go through the pages projection below. ## Continuation Modules that can return more results than one request carries add their tokens to a top-level `continue` object, typed as [`ApiQueryContinue`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md) — another declaration-merged interface, where each module contributes a key named after its parameter prefix (e.g. `cmcontinue` for `list=categorymembers`), next to the generic opaque `continue` token. While the object is present, pass its keys back on the next request; spreading the whole object into the request is the usual way. Once it is absent, you have everything: ```ts import type { ApiQueryResponse } from "types-mediawiki-response"; const titles: string[] = []; let cont: ApiQueryResponse["continue"]; do { const res = (await api.get({ action: "query", list: "categorymembers", cmtitle: "Category:Contents", cmlimit: "max", ...cont, formatversion: "2", })) as ApiQueryResponse; titles.push(...(res.query.categorymembers ?? []).map(({ title }) => title)); cont = res.continue; } while (cont); ``` Both landing spots take part in continuation: list results and generator-driven page queries each contribute their own keys. ## Log event details Three modules surface the structured details of log entries, and the server normalizes them all into one shape: - `list=logevents`: each log entry's `params` (`leprop=details`) - `list=recentchanges`: `logparams` on `type=log` entries (`rcprop=loginfo`) - `list=watchlist`: `logparams` on `type=log` entries (`wlprop=loginfo`) All three are typed as [`ApiLogEventParams`](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md), covering every log action MediaWiki core writes. Which keys an entry actually carries depends on its `type`/`action` (a `block/block` entry carries `duration`/`flags`/`sitewide`, a `move/move` entry carries `target_ns`/`target_title`; each key's doc names the actions that carry it). Not every log action has detail keys: on `delete/delete` and `create/create` entries, `params` is an empty object `{}` — present, just empty. As with `ApiPage`, the union is wider than any single entry, and the compiler cannot correlate `params` with the entry's `action`, so check `type`/`action` at runtime before reading action-specific keys: ```ts import type { ApiQueryResponse } from "types-mediawiki-response"; const res = (await api.get({ action: "query", list: "logevents", leprop: "title|type|details", formatversion: "2", })) as ApiQueryResponse; for (const event of res.query.logevents ?? []) { // params reads as the full union on every entry — the check is for you, not the compiler if (event.type === "block") { event.params?.duration; // string | undefined } event.params?.tag; // string | undefined — declared keys read anywhere event.params?.whatever; // unknown — not declared, see below } ``` Keys outside the declared set fall through to the index signature and read as `unknown` instead of erroring. To promote keys you actually receive — say, from a site-custom log action — merge them into the interface: ```ts // mw-response.d.ts — inside your tsconfig include declare module "types-mediawiki-response" { interface ApiLogEventParams { /** Subject page of the site-custom `foo/foo` log action. */ foo?: string; } } ``` Merged, `event.params?.foo` reads as `string | undefined` instead of `unknown`. An augmented key has the same standing as a built-in one: it joins the shape shared by all log entries, so reading it compiles on entries of any action. Which action a field belongs to is a docstring convention (built-in keys work the same way: `duration` only ever appears on block-family rows); at runtime, go by `type`/`action`. If you want compile-time restriction of a read to one action, skip the augmentation and narrow `params` to a local shape (`ApiLogEventParams & { foo?: string }`) at the call site. The same seam for query fields is described in [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md). ## Narrowing pages with QueryPage `ApiPage` is a union, and the compiler does not know which `prop=` you requested, so a field you never asked for still typechecks. [`QueryPage`](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) puts that information back, narrowing the page to the props you actually requested: ```ts import type { ApiQueryResponse, QueryPage } from "types-mediawiki-response"; const res = (await api.get({ action: "query", prop: "revisions", titles, formatversion: "2", })) as ApiQueryResponse; // Not narrowed: ApiPage is the union, so unrequested fields look available const wide = res.query.pages ?? []; wide[0]?.revisions; // ok — requested wide[0]?.categories; // also "ok" — but this response carries no categories // Narrowed: identity fields + revisions only const narrow = (res.query.pages ?? []) as QueryPage<"revisions">[]; narrow[0]?.revisions; // ok narrow[0]?.categories; // compile error — not requested ``` `K` takes field keys of `ApiPage`. For most `prop=` modules the key matches the module name, and passing a union type projects several at once, e.g. `QueryPage<"revisions" | "categories">`. A few modules contribute several page-level keys at once; naming every key is long and easy to get wrong, so you can use the ready-made per-module aliases instead: | Module | Alias | Covers | | ------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------- | | `prop=info` | [`InfoPage`](https://types-mediawiki-response.pages.dev/api/core/InfoPage.md) | every page-level field `prop=info` contributes | | `prop=imageinfo` | [`ImageInfoPage`](https://types-mediawiki-response.pages.dev/api/core/ImageInfoPage.md) | `imageinfo`, `imagerepository`, `badfile` | | `prop=contributors` | [`ContributorsPage`](https://types-mediawiki-response.pages.dev/api/core/ContributorsPage.md) | `contributors`, `anoncontributors` | | `generator=search` | [`SearchPage`](https://types-mediawiki-response.pages.dev/api/core/SearchPage.md) | the hit fields `generator=search` injects | Spelling the keys by hand has two traps: - `QueryPage<"info">` does not compile, because `prop=info` has no `info` key. - `QueryPage<"imageinfo">` projects only the `imageinfo` array, not its sibling fields (`imagerepository` / `badfile`). ## How the projection works `QueryPage` is built from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md) (the identity fields shared by every page), the `index` a `generator=search` / `generator=prefixsearch` request injects, plus `Pick`. It is a pure type-level operation; it does not interfere with the per-module declaration merging, and fields contributed by opt-in extension packs participate in the projection too. [`QueryPageExisting`](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md) (and [`InfoPageExisting`](https://types-mediawiki-response.pages.dev/api/core/InfoPageExisting.md)) additionally require the picked fields their module writes unconditionally: the identity fields plus the `prop=info` core set and `revisions` (see [`PropConstantKeys`](https://types-mediawiki-response.pages.dev/api/core/PropConstantKeys.md)). Gated fields stay optional. --- url: https://types-mediawiki-response.pages.dev/guide/conventions.md --- > 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. # Field conventions The declarations mirror what the server actually sends, so a field's type already tells you how to read the value. These are the conventions that recur across modules; each field's JSDoc carries the specifics. ## Flags: `true` or absent A [`Flag`](https://types-mediawiki-response.pages.dev/api/core/Flag.md) field is `true` when set; when it is not set the key is omitted entirely — it never comes back as `false`. Both a truthiness check and an `in` check are correct: ```ts const edit = res.edit; if (edit.new) { // page created by this edit } "nochange" in edit; // membership check works the same way ``` Fields typed plain `boolean` are the opposite — they genuinely return `false` (e.g. `move.redirectcreated`, the flags echoed by `action=block`). Which regime a field uses is visible in its type. ## Empty string in place of omission Some modules return `''` when there is no value instead of dropping the key: - `prop=info`'s `notificationtimestamp` is `''` until the requesting user has visited the page (`Timestamp | ""`); - `action=move`'s `reason` is `''` when no summary was supplied; - `list=allusers`' `registration` is `''` for accounts created before registration timestamps were tracked. Others use `null` (`list=users`' `registration`) or omit the key altogether. The union in the field's type names its sentinel — don't assume one convention across modules. ## Keys are verbatim Keys keep the server's spelling exactly, hyphens included, and are read with bracket access: ```ts upload["duplicate-archive"]; general["git-hash"]; // meta=siteinfo ``` Legacy XML-style content keys are modeled the same way, as `"*"`: Echo's rendered notification body and MassMessage's invalid targets both arrive under `*`. ## `query.pages` is an array Under `formatversion=2` the pages container is a plain array of page objects — not the pageid-keyed map of fv1. Iterate it directly; `Object.values(res.query.pages ?? [])` compiles but is a leftover fv1 habit. Generator requests that impose their own order record it in each page's `index` field. ## Empty maps and empty lists A field the server emits as a map serializes as `{}` when empty; a list serializes as `[]`. The everyday example is the log details: on `delete/delete` rows, `params` is present but `{}` — see [Query responses](https://types-mediawiki-response.pages.dev/guide/query.md). Where the empty shape can occur, it is part of the field's union. ## Numbers occasionally arrive as strings Raw metadata is the recurring case: the `metadata` field on an imageinfo row — returned when the request includes `iiprop=metadata` — is an array of entries whose `name` / `value` are unions: names can be numeric (positional entries of list-shaped fields) and values can be numbers, booleans, or strings like `"num/den"`. These unions are per-field facts taken from real responses — trust the hover, not a package-wide rule. The `pages[0]` object of a live response (values verbatim from `www.mediawiki.org`): ```jsonc { "ns": 6, "title": "File:09808957674.png", "imageinfo": [ { "metadata": [ { "name": "frameCount", "value": 0 }, // numeric value { "name": "colorType", "value": "truecolour-alpha" }, // string value // ... { "name": "metadata", // array value; entries may nest further "value": [ { "name": "XResolution", "value": "2835/100" }, // a "num/den" string { "name": "ResolutionUnit", "value": 3 }, // ... { "name": "PNGFileComment", "value": [ { "name": "x-default", "value": "Created with GIMP" }, { "name": "_type", "value": "lang" }, ], }, ], }, ], }, ], } ``` ## Open and closed unions String unions come in two deliberate kinds: - **Closed**: the value set is hardcoded in MediaWiki's emitting code with no hook to change it (e.g. `prop=info`'s `pagelanguagedir`). The type lists exactly those values and rejects everything else. - **Open**: the value set depends on a registry, hook, or site configuration (e.g. `ContentModel`). Known values are listed for autocomplete, and `(string & {})` keeps any site-specific value assignable. Content models are open, because a site can register handlers through `$wgContentHandlers`: `ContentModel` accepts any string while offering the known ones on autocomplete. Open unions that ship a promotion interface — `ContentModelExtension` for content models — let you merge your site's own values in, so they read as first-class members instead of anonymous strings. The member shape differs from a field-group augmentation: a map from model name to itself: ```ts // mw-response.d.ts — the site registers `my-model` through $wgContentHandlers import type {} from "types-mediawiki-response"; // anchors the module for augmentation declare module "types-mediawiki-response" { interface ContentModelExtension { /** The value joins the union; the key is just a label. */ MyModel: "my-model"; } } ``` Afterwards `"my-model"` stands alongside the built-in known values in autocomplete, instead of being silently accepted by `(string & {})`. Where to keep the file and how the merge applies — see [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md). --- url: https://types-mediawiki-response.pages.dev/guide/ext-packs.md --- > 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. # Opt-in extension packs Core [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) / [`ApiQueryResult`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md) cover MediaWiki core fields only; the field types extensions introduce are split into opt-in packs by extension (subpath `types-mediawiki-response/ext/`). Activate the packs matching your wiki's installed extensions. There are two consumption scenarios, and they work differently: - **Fields of an installed extension's query modules**: a `list=` / `prop=` / `meta=` key showing up in a response. Activated once per project with a type-only import; afterwards the fields simply appear on `ApiPage` / `ApiQueryResult` everywhere. - **Extension actions** (`action=shortenurl`, `action=thank`, …): a standalone response type imported by name where you need it, like any core action response. ## Scenario 1: fields from installed extensions Each pack ships its own `declare module` augmentation — the keys and landing spots live in the package, so your project never freezes a snippet that drifts when the pack gains fields. Activating a pack is a single type-only import of anything from it: ```ts // mw-response.d.ts — declared once per repository, in any file covered by your tsconfig import type {} from "types-mediawiki-response/ext/flaggedrevs"; import type {} from "types-mediawiki-response/ext/globalusage"; // ApiPage.flagged / ApiPage.globalusage now exist in EVERY file of the project ``` A dedicated type file (e.g. `mw-response.d.ts`, kept inside your tsconfig `include`) is the recommended home: list every extension your wiki actually runs there. The augmentation applies to the whole project the tsconfig covers, so business code never repeats a declaration and can use `page.flagged` / `query.notifications` directly. Alternatively, simply importing the field-group type you need (e.g. [`ApiPageFlagged`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiPageFlagged.md)) anywhere also activates the pack. ## Scenario 2: calling an extension action Extension actions export a standalone response type named after the action — nothing merges into `ApiPage` / `ApiQueryResult`. Import it by name from the pack and use it like a core action response: ```ts import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks"; const res: ApiThankResponse = await api.post({ action: "thank", rev: 12345, }); res.result?.recipient; ``` Two things come with that one import: - The pack's query fields (if the extension also has query modules — e.g. `discussiontools` contributes both `action=discussiontools…` responses and `prop=threaditemshtml`) are activated at the same time. - You do not need the pack in `mw-response.d.ts` just to call its action; add it there only if you also consume its query fields. ## Packs that augment query types Activate these (scenario 1) if your wiki has the extension; the listed modules' fields appear on `ApiPage` / `ApiQueryResult`: | Subpath | Extension | Query modules | | ------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `abusefilters` | [AbuseFilter](https://www.mediawiki.org/wiki/Extension:AbuseFilter) | `list=abusefilters`, `list=abuselog` | | `babel` | [Babel](https://www.mediawiki.org/wiki/Extension:Babel) | `meta=babel` | | `betafeatures` | [BetaFeatures](https://www.mediawiki.org/wiki/Extension:BetaFeatures) | `list=betafeatures` | | `centralauth` | [CentralAuth](https://www.mediawiki.org/wiki/Extension:CentralAuth) | `list=globalallusers`, `list=globalgroups`, `list=globalusers`, `list=wikisets` | | `checkuser` | [CheckUser](https://www.mediawiki.org/wiki/Extension:CheckUser) | `list=checkuser`, `list=checkuserlog`, `meta=checkuserformattedblockinfo` | | `description` | [Wikibase Client](https://www.mediawiki.org/wiki/Extension:Wikibase_Client) | `prop=description` | | `echo` | [Echo](https://www.mediawiki.org/wiki/Extension:Echo) | `meta=notifications`, … | | `extracts` | [TextExtracts](https://www.mediawiki.org/wiki/Extension:TextExtracts) | `prop=extracts` | | `flaggedrevs` | [FlaggedRevs](https://www.mediawiki.org/wiki/Extension:FlaggedRevs) | `prop=flagged`, `list=unreviewedpages`, … | | `gadgets` | [Gadgets](https://www.mediawiki.org/wiki/Extension:Gadgets) | `list=gadgets` | | `globalblocks` | [GlobalBlocking](https://www.mediawiki.org/wiki/Extension:GlobalBlocking) | `list=globalblocks` | | `globalpreferences` | [GlobalPreferences](https://www.mediawiki.org/wiki/Extension:GlobalPreferences) | `meta=globalpreferences` | | `globalusage` | [GlobalUsage](https://www.mediawiki.org/wiki/Extension:GlobalUsage) | `prop=globalusage` | | `globaluserinfo` | [CentralAuth](https://www.mediawiki.org/wiki/Extension:CentralAuth) | `meta=globaluserinfo` | | `linter` | [Linter](https://www.mediawiki.org/wiki/Extension:Linter) | `list=linterrors`, `meta=linterstats` | | `massmessage` | [MassMessage](https://www.mediawiki.org/wiki/Extension:MassMessage) | `prop=mmcontent` | | `oathauth` | [OATHAuth](https://www.mediawiki.org/wiki/Extension:OATHAuth) | `meta=oath` (removed in OATHAuth 1.46) | | `pageimages` | [PageImages](https://www.mediawiki.org/wiki/Extension:PageImages) | `prop=pageimages` | | `pageviews` | [PageViewInfo](https://www.mediawiki.org/wiki/Extension:PageViewInfo) | `prop=pageviews`, `list=mostviewed`, `meta=siteviews` | | `readinglists` | [ReadingLists](https://www.mediawiki.org/wiki/Extension:ReadingLists) | `meta=readinglists`, `list=readinglistentries` | | `wikibase` | [Wikibase](https://www.mediawiki.org/wiki/Extension:Wikibase) | `meta=wikibase`, `prop=pageterms`, `list=wblistentityusage` | ## Packs that add new actions These export standalone response types (scenario 2) — import the one for the action you call: | Subpath | Response types | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `abusefilters` | `ApiAbuseFilterCheckSyntaxResponse`, `ApiAbuseFilterEvalExpressionResponse`, `ApiAbuseFilterCheckMatchResponse`, `ApiAbuseFilterUnblockAutopromoteResponse`, `ApiAbuseLogPrivateDetailsResponse` | | `categorytree` | `ApiCategoryTreeResponse` | | `centralauth` | `ApiCentralAuthTokenResponse`, `ApiGlobalUserRightsResponse`, `ApiSetGlobalAccountStatusResponse`, `ApiDeleteGlobalAccountResponse`, `ApiCreateLocalAccountResponse` | | `discussiontools` | `ApiDiscussionToolsEditResponse`, `ApiDiscussionToolsPageInfoResponse`, `ApiDiscussionToolsFindCommentResponse`, `ApiDiscussionToolsGetSubscriptionsResponse`, `ApiDiscussionToolsSubscribeResponse`, `ApiDiscussionToolsThankResponse`, `ApiDiscussionToolsCompareResponse`, `ApiDiscussionToolsPreviewResponse` | | `echo` | `ApiEchoMuteResponse`, `ApiEchoCreateEventResponse` | | `flaggedrevs` | `ApiReviewResponse`, `ApiStabilizeResponse`, `ApiFlagConfigResponse` | | `globalpreferences` | `ApiGlobalPreferencesResponse`, `ApiGlobalPreferenceOverridesResponse` | | `massmessage` | `ApiMassMessageResponse`, `ApiEditMassMessageListResponse` | | `oathauth` | `ApiOATHValidateResponse` (removed in OATHAuth 1.46) | | `readinglists` | `ApiReadingListsSetupResponse`, `ApiReadingListsCreateResponse`, `ApiReadingListsUpdateResponse`, `ApiReadingListsDeleteResponse`, `ApiReadingListsCreateEntryResponse`, `ApiReadingListsDeleteEntryResponse`, `ApiReadingListsTeardownResponse` | | `sitematrix` | `ApiSiteMatrixResponse` | | `spamblacklist` | `ApiSpamBlacklistResponse` | | `templatedata` | `ApiTemplateDataResponse` | | `thanks` | `ApiThankResponse` | | `timedmediahandler` | `ApiTranscodeResetResponse` | | `titleblacklist` | `ApiTitleBlacklistResponse` | | `translate` | `ApiAggregateGroupsResponse`, `ApiGroupReviewResponse`, `ApiMarkForTranslationResponse`, `ApiMessageGroupSubscriptionResponse`, `ApiSearchTranslationsResponse`, `ApiTranslateSandboxActionResponse`, `ApiTranslateSandboxCreateResponse`, `ApiTranslationAidsResponse`, `ApiTranslationEntitySearchResponse`, `ApiTranslationReviewResponse`, `ApiTranslationStashResponse`, `ApiTranslationStatsResponse`, `ApiTtmServerResponse` | | `uls` | `ApiUlsLocalizationResponse`, `ApiUlsSetLanguageResponse` | | `urlshortener` | `ApiShortenUrlResponse` | | `visualeditor` | `ApiVisualEditorResponse`, `ApiVisualEditorEditResponse`, `ApiVisualEditorTemplatesUsedResponse`, `ApiEditCheckReferenceUrlResponse` | | `wikilove` | `ApiWikiLoveResponse` | Packs appearing in both tables (e.g. `abusefilters`, `discussiontools`, `flaggedrevs`) serve both scenarios — activate them once and import their action types by name as needed. ## Adding types the package does not cover The same seam is general: fields reach a response from sources this package does not cover — an extension it has no pack for, or a site fork that adds fields to core module results. Declare the shape yourself and merge it at the matching landing spot with a hand-written module augmentation; like the built-in packs, the merge applies to the whole project. - Page-level `prop=` fields merge into `ApiPage`; other query results merge into `ApiQueryResult`. - Row interfaces — the per-entry objects inside a list result (`ApiUser` for `list=users`, `ApiRecentChange` for `list=recentchanges`, …) — are augmented directly when the site adds per-entry fields. - Log details merge into [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md) — site-custom log actions, and legacy key forms still in old rows, both land here. - Known values of an open union (a site-registered content model, for example) are promoted through the union's augmentation interface, such as `ContentModelExtension` — see [Field conventions](https://types-mediawiki-response.pages.dev/guide/conventions.md) for the open/closed distinction and a worked example. - Action responses are standalone envelopes with nothing to merge into; a new action from an uncovered source is just a plain interface you define and import. ```ts // types/mw-response.d.ts — for the (uncovered) Foo extension's `prop=foo` import type { Flag } from "types-mediawiki-response"; /** Field group contributed by `prop=foo`. */ export interface ApiPageFoo { /** Some status flag. */ fooflag?: Flag; /** Some URL. */ foourl?: string; } declare module "types-mediawiki-response" { interface ApiPage { foo?: ApiPageFoo; } } ``` Keep the file inside your tsconfig `include`; like the built-in packs, the merge applies to the whole project. Site-custom fields on a list entry go to the row interface itself: ```ts // types/mw-response.d.ts — a site fork adds per-user fields to `list=users` import type {} from "types-mediawiki-response"; // anchors the module for augmentation declare module "types-mediawiki-response" { interface ApiUser { /** Site-custom display name; `null` when unset. */ displayname?: string | null; } } ``` A new action needs no augmentation: declare a `Response extends ApiEnvelope` interface in your own code and import it where you call the action: ```ts import type { ApiEnvelope } from "types-mediawiki-response"; /** Response of `action=bar` from the uncovered Bar extension. */ export interface ApiBarResponse extends ApiEnvelope { /** Result of the action. */ result?: { /** Some count. */ count: number; }; } ``` --- url: https://types-mediawiki-response.pages.dev/guide/examples.md --- > 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. # Examples The repository ships three minimal consumer projects under [`examples/`](https://github.com/BearBin1215/types-mediawiki-response/tree/main/examples), covering three common consumption scenarios: | Example | Scenario | Typing pattern | | ------------------------------------------------------------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------- | | [`web-ts`](https://github.com/BearBin1215/types-mediawiki-response/tree/main/examples/web-ts) | A gadget written in TS and bundled for use | `import type { ApiXxxResponse }` + `as` assertion on `mw.Api` results | | [`web-js`](https://github.com/BearBin1215/types-mediawiki-response/tree/main/examples/web-js) | A gadget kept in plain JS | JSDoc `/** @type {X} */` cast, hover hints in the IDE | | [`node-bot`](https://github.com/BearBin1215/types-mediawiki-response/tree/main/examples/node-bot) | A client script running on Node | Generic argument on a request wrapper: `request(...)` | ## web-ts: gadget in TypeScript The gadget workflow: `mw` globals from `types-mediawiki`, response types declared with this package, bundled before deployment. `src/index.ts` demonstrates three shapes: - Parsed wikitext (`action=parse`). - Global usages of a file (`prop=globalusage`, activated by a type-only import of the GlobalUsage pack, see [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md)). - A token-guarded edit (`postWithToken`). Every result is typed with an `as` assertion; the imports are type-only and get erased by the bundler. ## web-js: gadget in plain JavaScript Same runtime environment, no build step: JSDoc provides the types and the IDE renders them on hover. The example shows two JSDoc idioms: - `@typedef` aliases. - The `/** @type {X} */` cast that narrows the loose value `mw.Api` resolves to. The tsconfig enables `checkJs`, so CI validates the JSDoc too. ## node-bot: bot client on Node There is no `mw.Api` global class like a MediaWiki page provides: a hand-rolled `Bot` class wraps `fetch` and takes the response type as a generic argument — `request({ action: "query", … })`. It covers the pieces a bot actually needs: a descriptive `User-Agent`, `meta=tokens` for the CSRF token, `QueryPage<"revisions">` to scope `query.pages` to the requested props, and an `edit.result` check. ## Try them ```bash git clone https://github.com/BearBin1215/types-mediawiki-response.git cd types-mediawiki-response pnpm install pnpm build && pnpm check:examples # builds the package, typechecks all three ``` To check a single example: `cd examples/web-ts && pnpm typecheck`. --- url: https://types-mediawiki-response.pages.dev/guide/qa.md --- > 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. # FAQ ## Paginated query loop errors with TS7022 When you page through a `list=` module, you may end up carrying the continuation cursor as a single variable that both goes into the request and comes back out of the response: ```ts import type { ApiQueryResponse } from "types-mediawiki-response"; const titles: string[] = []; let cmcontinue: string | false = false; do { // ❌ TS7022: 'res' implicitly has type 'any' … const res = await api.get({ action: "query", list: "categorymembers", cmtitle: "Category:Games", cmlimit: "max", cmcontinue, // (1) the cursor goes into the request … }); cmcontinue = res.continue?.cmcontinue || false; // (2) … and comes back out of res titles.push(...(res.query.categorymembers ?? []).map((m) => m.title ?? "")); } while (cmcontinue); ``` This only triggers when your client's return type is chosen by the caller (a generic `get` / `post` returning `Promise`). Clients that cast the result — as in `(await api.get({ … })) as ApiQueryResponse` — never run into it. **Cause.** `res`'s type is inferred from the call, and the call's argument is the object literal just above. That literal embeds the shorthand property `cmcontinue` (1), so typing the argument first needs the type of `cmcontinue` — but `cmcontinue` is assigned back from `res` at (2). The dependency runs straight back into the binding being declared: ``` res → api.get({ …, cmcontinue }) → cmcontinue → res.continue → res ``` TypeScript cannot resolve the cycle, so under `noImplicitAny` it gives up and types `res` as `any`. The TS7006 you then see on `m` in the `.map((m) => …)` line is just fallout. **Fix — any one of these breaks the cycle.** 1. Annotate the response, so its type no longer has to be inferred through the argument: ```ts const res: ApiQueryResponse = await api.get({ /* … */ cmcontinue, }); ``` 2. Spread a single, independently typed `continue` object in place of the cursor variable, so the request body references nothing derived from `res` inside its own initializer: ```ts const titles: string[] = []; let cont: ApiQueryResponse["continue"]; do { const res = await api.get({ action: "query", list: "categorymembers", cmtitle: "Category:Games", cmlimit: "max", ...cont, }); titles.push(...(res.query.categorymembers ?? []).map((m) => m.title ?? "")); cont = res.continue; } while (cont); ``` 3. Cast the awaited result instead of passing a type argument: ```ts const res = (await api.get({ /* … */ cmcontinue })) as ApiQueryResponse; ``` --- url: https://types-mediawiki-response.pages.dev/api/index.md --- > 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. # API reference The field-level pages are generated from the declarations, so they always match what ships; each field's semantics, deprecations and parameter constraints live in its JSDoc, both here and on hover in your IDE. Concepts — the response envelope and error handling, paging through `query` results, narrowing `query.pages` with `QueryPage`, reading log event details, how field types map to the wire format, activating extension packs — are covered in the [guide](https://types-mediawiki-response.pages.dev/guide/getting-started.md). This tree is the field-level reference. ## Core Everything MediaWiki **core** can return: the response envelope ([ApiEnvelope](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md), [ApiResponseWith](https://types-mediawiki-response.pages.dev/api/core/ApiResponseWith.md)), shared atoms ([Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md), [Timestamp](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) …), one response type per `action=` ([ApiQueryResponse](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md), [ApiEditResponse](https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md) …), and the `action=query` framework — [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md), [ApiQueryResult](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md), the [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) projection, per-module continue tokens ([ApiQueryContinue](https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md)) and the per-action structured log details of [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md). Each single-module `action=` maps to one response type: | `action=` | Response type | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `action=acquiretempusername` | [ApiAcquireTempUserNameResponse](https://types-mediawiki-response.pages.dev/api/core/ApiAcquireTempUserNameResponse.md) | | `action=block` | [ApiBlockResponse](https://types-mediawiki-response.pages.dev/api/core/ApiBlockResponse.md) | | `action=changeauthenticationdata` | [ApiChangeAuthenticationDataResponse](https://types-mediawiki-response.pages.dev/api/core/ApiChangeAuthenticationDataResponse.md) | | `action=changecontentmodel` | [ApiChangeContentModelResponse](https://types-mediawiki-response.pages.dev/api/core/ApiChangeContentModelResponse.md) | | `action=checktoken` | [ApiCheckTokenResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md) | | `action=clearhasmsg` | [ApiClearHasMsgResponse](https://types-mediawiki-response.pages.dev/api/core/ApiClearHasMsgResponse.md) | | `action=clientlogin` | [ApiClientLoginResponse](https://types-mediawiki-response.pages.dev/api/core/ApiClientLoginResponse.md) | | `action=compare` | [ApiCompareResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCompareResponse.md) | | `action=createaccount` | [ApiCreateAccountResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCreateAccountResponse.md) | | `action=delete` | [ApiDeleteResponse](https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResponse.md) | | `action=edit` | [ApiEditResponse](https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md) | | `action=emailuser` | [ApiEmailUserResponse](https://types-mediawiki-response.pages.dev/api/core/ApiEmailUserResponse.md) | | `action=expandtemplates` | [ApiExpandTemplatesResponse](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResponse.md) | | `action=filerevert` | [ApiFileRevertResponse](https://types-mediawiki-response.pages.dev/api/core/ApiFileRevertResponse.md) | | `action=imagerotate` | [ApiImageRotateResponse](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateResponse.md) | | `action=import` | [ApiImportResponse](https://types-mediawiki-response.pages.dev/api/core/ApiImportResponse.md) | | `action=languagesearch` | [ApiLanguageSearchResponse](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageSearchResponse.md) | | `action=login` | [ApiLoginResponse](https://types-mediawiki-response.pages.dev/api/core/ApiLoginResponse.md) | | `action=logout` | [ApiLogoutResponse](https://types-mediawiki-response.pages.dev/api/core/ApiLogoutResponse.md) | | `action=managetags` | [ApiManageTagsResponse](https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsResponse.md) | | `action=mergehistory` | [ApiMergeHistoryResponse](https://types-mediawiki-response.pages.dev/api/core/ApiMergeHistoryResponse.md) | | `action=move` | [ApiMoveResponse](https://types-mediawiki-response.pages.dev/api/core/ApiMoveResponse.md) | | `action=options` | [ApiOptionsResponse](https://types-mediawiki-response.pages.dev/api/core/ApiOptionsResponse.md) | | `action=parse` | [ApiParseResponse](https://types-mediawiki-response.pages.dev/api/core/ApiParseResponse.md) | | `action=patrol` | [ApiPatrolResponse](https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResponse.md) | | `action=protect` | [ApiProtectResponse](https://types-mediawiki-response.pages.dev/api/core/ApiProtectResponse.md) | | `action=purge` | [ApiPurgeResponse](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeResponse.md) | | `action=query` | [ApiQueryResponse](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md) | | `action=removeauthenticationdata` | [ApiRemoveAuthenticationDataResponse](https://types-mediawiki-response.pages.dev/api/core/ApiRemoveAuthenticationDataResponse.md) | | `action=resetpassword` | [ApiResetPasswordResponse](https://types-mediawiki-response.pages.dev/api/core/ApiResetPasswordResponse.md) | | `action=revisiondelete` | [ApiRevisionDeleteResponse](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResponse.md) | | `action=rollback` | [ApiRollbackResponse](https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResponse.md) | | `action=setnotificationtimestamp` | [ApiSetNotificationTimestampResponse](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampResponse.md) | | `action=setpagelanguage` | [ApiSetPageLanguageResponse](https://types-mediawiki-response.pages.dev/api/core/ApiSetPageLanguageResponse.md) | | `action=stashedit` | [ApiStashEditResponse](https://types-mediawiki-response.pages.dev/api/core/ApiStashEditResponse.md) | | `action=tag` | [ApiTagResponse](https://types-mediawiki-response.pages.dev/api/core/ApiTagResponse.md) | | `action=unblock` | [ApiUnblockResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResponse.md) | | `action=undelete` | [ApiUndeleteResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResponse.md) | | `action=upload` | [ApiUploadResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUploadResponse.md) | | `action=userrights` | [ApiUserrightsResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUserrightsResponse.md) | | `action=validatepassword` | [ApiValidatePasswordResponse](https://types-mediawiki-response.pages.dev/api/core/ApiValidatePasswordResponse.md) | | `action=watch` | [ApiWatchResponse](https://types-mediawiki-response.pages.dev/api/core/ApiWatchResponse.md) | Browse the [full Core reference](https://types-mediawiki-response.pages.dev/api/core/overview.md). ## Extension packs Extension responses are opt-in: each pack lives at the subpath `types-mediawiki-response/ext/` and is activated by a single type-only import — see [Opt-in extension packs](https://types-mediawiki-response.pages.dev/guide/ext-packs.md). Packs for query sub-modules merge their fields into the shared `ApiPage` / `ApiQueryResult`; packs for extension actions export standalone response types to `import type` directly. | Pack | Extension | Covers | | -------------------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------- | | [abusefilters](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/overview.md) | AbuseFilter | `list=abusefilters` / `list=abuselog`, `action=abusefilter*` checks | | [babel](https://types-mediawiki-response.pages.dev/api/extensions/babel/overview.md) | Babel | `meta=babel` | | [categorytree](https://types-mediawiki-response.pages.dev/api/extensions/categorytree/overview.md) | CategoryTree | `action=categorytree` (standalone) | | [description](https://types-mediawiki-response.pages.dev/api/extensions/description/overview.md) | Wikibase Client | `prop=description` | | [discussiontools](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/overview.md) | DiscussionTools | `action=discussiontools*` (pageinfo, findcomment, subscriptions, …) | | [echo](https://types-mediawiki-response.pages.dev/api/extensions/echo/overview.md) | Echo / Notifications | `meta=notifications` and related `meta=` / `action=echomute`, `action=echocreateevent` | | [extracts](https://types-mediawiki-response.pages.dev/api/extensions/extracts/overview.md) | TextExtracts | `prop=extracts` | | [flaggedrevs](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/overview.md) | FlaggedRevs | `prop=flagged`, `list=unreviewedpages` …, `action=review` / `action=stabilize` | | [gadgets](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/overview.md) | Gadgets | `list=gadgets`, `list=gadgetcategories` | | [globalblocks](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/overview.md) | GlobalBlocking | `list=globalblocks` | | [globalusage](https://types-mediawiki-response.pages.dev/api/extensions/globalusage/overview.md) | GlobalUsage | `prop=globalusage` | | [globaluserinfo](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/overview.md) | CentralAuth | `meta=globaluserinfo` | | [linter](https://types-mediawiki-response.pages.dev/api/extensions/linter/overview.md) | Linter | `list=linterrors`, `meta=linterstats` | | [pageimages](https://types-mediawiki-response.pages.dev/api/extensions/pageimages/overview.md) | PageImages | `prop=pageimages` | | [pageviews](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/overview.md) | PageViewInfo | `prop=pageviews`, `list=mostviewed`, `meta=siteviews` | | [scribunto](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/overview.md) | Scribunto | `action=scribunto-console` (standalone) | | [spamblacklist](https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/overview.md) | SpamBlacklist | `action=spamblacklist` (standalone) | | [templatedata](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/overview.md) | TemplateData | `action=templatedata` (standalone) | | [thanks](https://types-mediawiki-response.pages.dev/api/extensions/thanks/overview.md) | Thanks | `action=thank` (standalone) | | [titleblacklist](https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/overview.md) | TitleBlacklist | `action=titleblacklist` (standalone) | | [visualeditor](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/overview.md) | VisualEditor | `action=visualeditor`, `action=visualeditoredit` … (standalone) | | [wikibase](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/overview.md) | Wikibase | `meta=wikibase`, `prop=pageterms`, `list=wblistentityusage` | --- url: https://types-mediawiki-response.pages.dev/api/core/overview.md --- > 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. # Core ## Interfaces | Interface | Description | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiAcceptLang](https://types-mediawiki-response.pages.dev/api/core/ApiAcceptLang.md) | One entry of the `acceptlang` list (a browser `Accept-Language` parse). | | | [ApiAcquireTempUserNameResponse](https://types-mediawiki-response.pages.dev/api/core/ApiAcquireTempUserNameResponse.md) | Response of `action=acquiretempusername`. | | | [ApiActionPermission](https://types-mediawiki-response.pages.dev/api/core/ApiActionPermission.md) | One permission-check failure reported under \`intestactionsdetail=full | quick`. The text-bearing keys depend on the request's `errorformat`: `text`for`plaintext`/`wikitext`, `html`for`html`, `key`/`params`for`raw`, and none of them for `none`. A request using the default (`bc`) format is rendered as `plaintext\` here. | | [ApiAllCategory](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md) | One category summary. \`acprop=size | hidden\` selects the optional fields. | | [ApiAllDeletedRevisions](https://types-mediawiki-response.pages.dev/api/core/ApiAllDeletedRevisions.md) | One page carrying at least one deleted revision. | | | [ApiAllImage](https://types-mediawiki-response.pages.dev/api/core/ApiAllImage.md) | One file listed by `list=allimages`. | | | [ApiAllLink](https://types-mediawiki-response.pages.dev/api/core/ApiAllLink.md) | One linked (or redirected-to / transcluded) title. | | | [ApiAllMessage](https://types-mediawiki-response.pages.dev/api/core/ApiAllMessage.md) | One interface message. | | | [ApiAllPage](https://types-mediawiki-response.pages.dev/api/core/ApiAllPage.md) | One page listed by `list=allpages`. | | | [ApiAllRevisions](https://types-mediawiki-response.pages.dev/api/core/ApiAllRevisions.md) | One page with the revisions requested for it. | | | [ApiAuthManagerRawMessage](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerRawMessage.md) | A message in raw form (`amimessageformat=raw`): the i18n key plus parameters. | | | [ApiAutoCreateTempUser](https://types-mediawiki-response.pages.dev/api/core/ApiAutoCreateTempUser.md) | Temporary-account creation config (`siprop=autocreatetempuser`). | | | [ApiAutopromoteCondition](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md) | One autopromote condition. A group's set is an **object with numeric keys** under fv2 (the PHP array also carries `operand`), so nested sets surface as `"0"`, `"1"`, … entries alongside [operand](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md#operand). | | | [ApiAutopromoteConditions](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteConditions.md) | Autopromote condition sets keyed by group name (`siprop=autopromote`). A full condition set arrives as a single [ApiAutopromoteCondition](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md) carrying an `operand`; a single-condition or bare-string configuration arrives wrapped in a one-element array. | | | [ApiAutopromoteOnce](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteOnce.md) | Autopromote-once configuration keyed by hook name (`siprop=autopromoteonce`). A hook with nothing configured arrives as an empty **array**, because `formatversion=2` cannot tell an empty PHP list from an empty map. | | | [ApiBacklink](https://types-mediawiki-response.pages.dev/api/core/ApiBacklink.md) | One page that links to the target title. | | | [ApiBcErrorResponse](https://types-mediawiki-response.pages.dev/api/core/ApiBcErrorResponse.md) | Error response under the default (`bc`) `errorformat`: a single `error` object. | | | [ApiBlock](https://types-mediawiki-response.pages.dev/api/core/ApiBlock.md) | One block record. `bkprop` controls which fields appear. | | | [ApiBlockInfo](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md) | Block details, as emitted for `usprop=blockinfo` (list=users) and `uiprop=blockinfo` (meta=userinfo). Only present when the user is blocked. The same shape is shared by [ApiUser.blockcomponents](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockcomponents) entries. | | | [ApiBlockResponse](https://types-mediawiki-response.pages.dev/api/core/ApiBlockResponse.md) | Response of `action=block`. | | | [ApiBlockRestrictions](https://types-mediawiki-response.pages.dev/api/core/ApiBlockRestrictions.md) | Restriction targets of a partial block, grouped by kind. | | | [ApiBlockResult](https://types-mediawiki-response.pages.dev/api/core/ApiBlockResult.md) | The `block` object of an `action=block` response. | | | [ApiCategory](https://types-mediawiki-response.pages.dev/api/core/ApiCategory.md) | One category membership entry; `clprop` selects the optional fields. | | | [ApiCategoryInfo](https://types-mediawiki-response.pages.dev/api/core/ApiCategoryInfo.md) | Category size statistics (`prop=categoryinfo`). | | | [ApiCategoryMember](https://types-mediawiki-response.pages.dev/api/core/ApiCategoryMember.md) | One category member. `cmprop` controls which fields appear. | | | [ApiChangeAuthenticationDataResponse](https://types-mediawiki-response.pages.dev/api/core/ApiChangeAuthenticationDataResponse.md) | Response of `action=changeauthenticationdata`. | | | [ApiChangeContentModelResponse](https://types-mediawiki-response.pages.dev/api/core/ApiChangeContentModelResponse.md) | Response of `action=changecontentmodel`. | | | [ApiCheckTokenResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md) | Response of `action=checktoken`. | | | [ApiClearHasMsgResponse](https://types-mediawiki-response.pages.dev/api/core/ApiClearHasMsgResponse.md) | Response of `action=clearhasmsg`. | | | [ApiClientLogin](https://types-mediawiki-response.pages.dev/api/core/ApiClientLogin.md) | The `clientlogin` object of an `action=clientlogin` response. | | | [ApiClientLoginResponse](https://types-mediawiki-response.pages.dev/api/core/ApiClientLoginResponse.md) | Response of `action=clientlogin`. | | | [ApiCodexIconDefinition](https://types-mediawiki-response.pages.dev/api/core/ApiCodexIconDefinition.md) | Directionality/language-aware icon definition (object form of [ApiCodexIcon](https://types-mediawiki-response.pages.dev/api/core/ApiCodexIcon.md)). | | | [ApiCompareResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCompareResponse.md) | Response of `action=compare`. | | | [ApiCompareResult](https://types-mediawiki-response.pages.dev/api/core/ApiCompareResult.md) | The `compare` object of a successful `action=compare` response. | | | [ApiContributor](https://types-mediawiki-response.pages.dev/api/core/ApiContributor.md) | One contributor entry: a logged-in (registered or temporary) editor. | | | [ApiCreateAccountResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCreateAccountResponse.md) | Response of `action=createaccount`. | | | [ApiDbReplLag](https://types-mediawiki-response.pages.dev/api/core/ApiDbReplLag.md) | One database host (`siprop=dbrepllag`). | | | [ApiDeletedRev](https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRev.md) | One archived revision, as `list=deletedrevs` formats it. | | | [ApiDeletedRevs](https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRevs.md) | One page group. `drprop=content` also yields the revision text. | | | [ApiDeleteResponse](https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResponse.md) | Response of `action=delete`. | | | [ApiDeleteResult](https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResult.md) | The `delete` object of an `action=delete` response. | | | [ApiDuplicateFile](https://types-mediawiki-response.pages.dev/api/core/ApiDuplicateFile.md) | One other file with the same content. | | | [ApiEditCaptcha](https://types-mediawiki-response.pages.dev/api/core/ApiEditCaptcha.md) | The captcha challenge of a `result: "Failure"` edit, as emitted by ConfirmEdit. | | | [ApiEditResponse](https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md) | Response of `action=edit`. | | | [ApiEditResult](https://types-mediawiki-response.pages.dev/api/core/ApiEditResult.md) | The `edit` object of an `action=edit` response. | | | [ApiEmailUserResponse](https://types-mediawiki-response.pages.dev/api/core/ApiEmailUserResponse.md) | Response of `action=emailuser`. | | | [ApiEmbeddedIn](https://types-mediawiki-response.pages.dev/api/core/ApiEmbeddedIn.md) | One page that embeds the target title. | | | [ApiEnvelope](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) | Fields that may appear on every API response, successful or not. | | | [ApiError](https://types-mediawiki-response.pages.dev/api/core/ApiError.md) | The `error` object under the default (`bc`) `errorformat`. | | | [ApiExpandTemplatesCategory](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesCategory.md) | One category the output would add. | | | [ApiExpandTemplatesProperties](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesProperties.md) | Page settings surfaced by `prop=properties`. Open key set. | | | [ApiExpandTemplatesResponse](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResponse.md) | Response of `action=expandtemplates`. | | | [ApiExpandTemplatesResult](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResult.md) | The `expandtemplates` object of a successful response. | | | [ApiExternalLink](https://types-mediawiki-response.pages.dev/api/core/ApiExternalLink.md) | One external link used by a page. | | | [ApiExtMetadataField](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataField.md) | One structured `extmetadata` field. | | | [ApiExtMetadataMultilangValue](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataMultilangValue.md) | A multilang metadata value (`iiextmetadatamultilang=1`): the map of language codes to values that the API otherwise collapses to the best-matching language. `x-default` holds the fallback translation. | | | [ApiExtUrlUsage](https://types-mediawiki-response.pages.dev/api/core/ApiExtUrlUsage.md) | One page whose content links to the searched URL. | | | [ApiFileArchiveEntry](https://types-mediawiki-response.pages.dev/api/core/ApiFileArchiveEntry.md) | One archived file. `faprop` selects the optional fields; `id`, `name`, `ns` and `title` are emitted regardless of `faprop`. | | | [ApiFileExtension](https://types-mediawiki-response.pages.dev/api/core/ApiFileExtension.md) | One uploadable file extension (`siprop=fileextensions`). | | | [ApiFileRepoInfo](https://types-mediawiki-response.pages.dev/api/core/ApiFileRepoInfo.md) | One file repository: an element of the `query.repos` array. | | | [ApiFileRevertResponse](https://types-mediawiki-response.pages.dev/api/core/ApiFileRevertResponse.md) | Response of `action=filerevert`. | | | [ApiFileUsage](https://types-mediawiki-response.pages.dev/api/core/ApiFileUsage.md) | One local usage record. `fuprop` controls which fields appear. | | | [ApiGalleryOptions](https://types-mediawiki-response.pages.dev/api/core/ApiGalleryOptions.md) | `general.galleryoptions`: the site's `$wgGalleryOptions`, with core's defaults filled in for any key the site omits. | | | [ApiHiddenFlags](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) | Suppression ("RevisionDelete") visibility flags shared by the modules that report hidden users, comments and whole entries; each appears as a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) when that part of the record is hidden. | | | [ApiImageInfo](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md) | One image-info entry for a file page. | | | [ApiImageLimit](https://types-mediawiki-response.pages.dev/api/core/ApiImageLimit.md) | One entry of `general.imagelimits`: a selectable display size. | | | [ApiImageMetadataItem](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md) | One entry in a file's raw format `metadata` array (may nest further items). | | | [ApiImageRotateEntry](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateEntry.md) | One file entry of an `action=imagerotate` response. | | | [ApiImageRotateResponse](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateResponse.md) | Response of `action=imagerotate`. | | | [ApiImageUsage](https://types-mediawiki-response.pages.dev/api/core/ApiImageUsage.md) | One page that uses the target file. | | | [ApiImportEntry](https://types-mediawiki-response.pages.dev/api/core/ApiImportEntry.md) | One imported page reported by `action=import`. | | | [ApiImportResponse](https://types-mediawiki-response.pages.dev/api/core/ApiImportResponse.md) | Response of `action=import`. | | | [ApiInterwikiLink](https://types-mediawiki-response.pages.dev/api/core/ApiInterwikiLink.md) | One interwiki link. | | | [ApiInterwikiMapEntry](https://types-mediawiki-response.pages.dev/api/core/ApiInterwikiMapEntry.md) | One interwiki prefix (`siprop=interwikimap`). | | | [ApiIwbacklink](https://types-mediawiki-response.pages.dev/api/core/ApiIwbacklink.md) | One page carrying the searched interwiki link. | | | [ApiLangbacklink](https://types-mediawiki-response.pages.dev/api/core/ApiLangbacklink.md) | One page carrying the searched language link. | | | [ApiLangLink](https://types-mediawiki-response.pages.dev/api/core/ApiLangLink.md) | One interlanguage link. | | | [ApiLanguageInfo](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageInfo.md) | Information about one language (`meta=languageinfo`, keyed by code). | | | [ApiLanguageSearchResponse](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageSearchResponse.md) | Response of `action=languagesearch`. | | | [ApiLanguageVariant](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageVariant.md) | One language variant and its fallbacks (`siprop=languagevariants`). | | | [ApiLinksHere](https://types-mediawiki-response.pages.dev/api/core/ApiLinksHere.md) | One page in a `linkshere` result. `lhprop` controls which fields appear. | | | [ApiLogBlockRestrictions](https://types-mediawiki-response.pages.dev/api/core/ApiLogBlockRestrictions.md) | Scope of a partial block (`restrictions`). | | | [ApiLogEvent](https://types-mediawiki-response.pages.dev/api/core/ApiLogEvent.md) | One log event. `leprop` controls which fields appear. | | | [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md) | Structured log details — the `params` object of a log event (`leprop=details` on `list=logevents`, `logparams` under the log-info fields of `list=recentchanges` / `list=watchlist`). | | | [ApiLogGroupMetadata](https://types-mediawiki-response.pages.dev/api/core/ApiLogGroupMetadata.md) | One group-membership change with its expiry (`oldmetadata`/`newmetadata` entry). | | | [ApiLoginResponse](https://types-mediawiki-response.pages.dev/api/core/ApiLoginResponse.md) | Response of the deprecated `action=login`. | | | [ApiLogoutResponse](https://types-mediawiki-response.pages.dev/api/core/ApiLogoutResponse.md) | Response of `action=logout`. No payload keys are emitted on success; the type exists so the shape is explicit (the `logout.status` object older builds returned is gone in 1.43). | | | [ApiLogPageRef](https://types-mediawiki-response.pages.dev/api/core/ApiLogPageRef.md) | One page a partial block is restricted to (`restrictions.pages` entry). | | | [ApiLogProtectDetail](https://types-mediawiki-response.pages.dev/api/core/ApiLogProtectDetail.md) | One protection restriction (`details` entry on `protect/protect`, `protect/modify`). | | | [ApiLogRevDelVisibility](https://types-mediawiki-response.pages.dev/api/core/ApiLogRevDelVisibility.md) | One visibility state (`old`/`new` on a RevisionDelete row). | | | [ApiMagicWord](https://types-mediawiki-response.pages.dev/api/core/ApiMagicWord.md) | One magic word (`siprop=magicwords`). | | | [ApiManageTagsResponse](https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsResponse.md) | Response of `action=managetags`. | | | [ApiMergeHistoryResponse](https://types-mediawiki-response.pages.dev/api/core/ApiMergeHistoryResponse.md) | Response of `action=mergehistory`. | | | [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) | 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`. | | | [ApiMessageParamSpec](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParamSpec.md) | 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`). | | | [ApiModernErrorResponse](https://types-mediawiki-response.pages.dev/api/core/ApiModernErrorResponse.md) | Error response under a modern `errorformat`: an `errors` array plus top-level `docref`. | | | [ApiMoveResponse](https://types-mediawiki-response.pages.dev/api/core/ApiMoveResponse.md) | Response of `action=move`. | | | [ApiMoveResult](https://types-mediawiki-response.pages.dev/api/core/ApiMoveResult.md) | The `move` object of a successful `action=move` response. | | | [ApiMoveSubpage](https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpage.md) | One subpage move outcome within `subpages`/`subpages-talk`. | | | [ApiMoveSubpageErrors](https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpageErrors.md) | The object form of `subpages`, returned only when the whole move failed. | | | [ApiNamespaceAlias](https://types-mediawiki-response.pages.dev/api/core/ApiNamespaceAlias.md) | One localized namespace alias (`siprop=namespacealiases`). | | | [ApiNamespaceInfo](https://types-mediawiki-response.pages.dev/api/core/ApiNamespaceInfo.md) | One namespace entry in `query.namespaces`, keyed by namespace index. | | | [ApiNamespaces](https://types-mediawiki-response.pages.dev/api/core/ApiNamespaces.md) | `query.namespaces`: a map from namespace index to its info. Negative indexes are pseudo-namespaces; some indexes are absent (gaps). | | | [ApiOptionsResponse](https://types-mediawiki-response.pages.dev/api/core/ApiOptionsResponse.md) | Response of `action=options`. | | | [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) | A `query.pages` entry carrying the union of all covered `prop=` fields. `prop=` modules widen this via declaration merging (see `./info`); every field is optional because pages may be missing/invalid and because a response only contains the props that were requested. | | | [ApiPageContributors](https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md) | Fields `prop=contributors` contributes to [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). [ContributorsPage](https://types-mediawiki-response.pages.dev/api/core/ContributorsPage.md) projects exactly this set. | | | [ApiPageIdentity](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md) | Framework identity fields present on every `query.pages` entry, regardless of which `prop=` modules were requested. | | | [ApiPageImageInfo](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md) | Page-level fields `prop=imageinfo` contributes to [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). [ImageInfoPage](https://types-mediawiki-response.pages.dev/api/core/ImageInfoPage.md) projects exactly this set. | | | [ApiPageInfo](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md) | Fields `prop=info` contributes to [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). [InfoPage](https://types-mediawiki-response.pages.dev/api/core/InfoPage.md) projects exactly this set. | | | [ApiPageLink](https://types-mediawiki-response.pages.dev/api/core/ApiPageLink.md) | One link made by a page. | | | [ApiPagePropName](https://types-mediawiki-response.pages.dev/api/core/ApiPagePropName.md) | One page property name in use. | | | [ApiPageProtection](https://types-mediawiki-response.pages.dev/api/core/ApiPageProtection.md) | One entry of a page's `protection` array (`inprop=protection`). | | | [ApiPageRef](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) | The `pageid`/`ns`/`title` page identity triple shared by `list=` module rows. | | | [ApiPagesWithProp](https://types-mediawiki-response.pages.dev/api/core/ApiPagesWithProp.md) | One page that defines the requested property. | | | [ApiParse](https://types-mediawiki-response.pages.dev/api/core/ApiParse.md) | The `parse` object of a successful `action=parse` response. `title` and `pageid` are written before any `prop` value is considered; with `onlypst=1` the module returns a different, metadata-free shape instead — see [ApiParseOnlyPstResponse](https://types-mediawiki-response.pages.dev/api/core/ApiParseOnlyPstResponse.md). | | | [ApiParseCategory](https://types-mediawiki-response.pages.dev/api/core/ApiParseCategory.md) | A category the parsed page would add itself to (`prop=categories`). | | | [~~ApiParseHeadItem~~](https://types-mediawiki-response.pages.dev/api/core/ApiParseHeadItem.md) | One raw `` element (`prop=headitems`). | | | [ApiParseIWLink](https://types-mediawiki-response.pages.dev/api/core/ApiParseIWLink.md) | An interwiki link (`prop=iwlinks`). | | | [ApiParseLangLink](https://types-mediawiki-response.pages.dev/api/core/ApiParseLangLink.md) | An interlanguage link (`prop=langlinks`). | | | [ApiParseLimitReportEntry](https://types-mediawiki-response.pages.dev/api/core/ApiParseLimitReportEntry.md) | One row of `limitreportdata` (`prop=limitreportdata`). fv2 keeps the PHP array's numeric keys, so the measurement(s) sit under `"0"`/`"1"`. | | | [ApiParseLink](https://types-mediawiki-response.pages.dev/api/core/ApiParseLink.md) | A wikilink or template used by the parsed page (`prop=links` / `prop=templates`). | | | [ApiParseOnlyPstResponse](https://types-mediawiki-response.pages.dev/api/core/ApiParseOnlyPstResponse.md) | Response of `action=parse&onlypst=1`: the module builds the payload before it resolves a title, so only the pre-save-transformed text comes back — no `title`/`pageid` and none of the `prop` sub-objects of [ApiParse](https://types-mediawiki-response.pages.dev/api/core/ApiParse.md). | | | [ApiParseRedirect](https://types-mediawiki-response.pages.dev/api/core/ApiParseRedirect.md) | One redirect resolution (with `redirects=1`, when parsing `page=`/`pageid=`). | | | [ApiParseResponse](https://types-mediawiki-response.pages.dev/api/core/ApiParseResponse.md) | Response of `action=parse`. | | | [ApiParseSection](https://types-mediawiki-response.pages.dev/api/core/ApiParseSection.md) | A table-of-contents entry (`prop=sections`) — the legacy projection of the same outline `prop=tocdata` emits, with lowercase keys here (`fromtitle`, `byteoffset`) against camelCase there (`fromTitle`, `codepointOffset`); see [ApiParseTocSection](https://types-mediawiki-response.pages.dev/api/core/ApiParseTocSection.md). `extensionData` appears only when non-empty. | | | [ApiParseTocData](https://types-mediawiki-response.pages.dev/api/core/ApiParseTocData.md) | The `tocdata` object (`prop=tocdata`). | | | [ApiParseTocSection](https://types-mediawiki-response.pages.dev/api/core/ApiParseTocSection.md) | One `tocdata` section (`prop=tocdata`) — the same outline as [ApiParseSection](https://types-mediawiki-response.pages.dev/api/core/ApiParseSection.md) but camelCased, with an HTML heading level instead of a wikitext `level` and a code-point offset instead of a byte offset. | | | [ApiPatrolResponse](https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResponse.md) | Response of `action=patrol`. | | | [ApiPatrolResult](https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResult.md) | The `patrol` object of a successful `action=patrol` response. | | | [ApiPrefixSearchResult](https://types-mediawiki-response.pages.dev/api/core/ApiPrefixSearchResult.md) | One prefix-search hit. | | | [ApiPreloadedContent](https://types-mediawiki-response.pages.dev/api/core/ApiPreloadedContent.md) | Preloaded edit content (`inprop=preloadcontent`), which fills the main slot. | | | [ApiProtectedTitle](https://types-mediawiki-response.pages.dev/api/core/ApiProtectedTitle.md) | One protected title. `ptprop` controls which fields appear. | | | [ApiProtectionEntry](https://types-mediawiki-response.pages.dev/api/core/ApiProtectionEntry.md) | One applied protection (`type` → level, plus `expiry`). | | | [ApiProtectResponse](https://types-mediawiki-response.pages.dev/api/core/ApiProtectResponse.md) | Response of `action=protect`. | | | [ApiProtectResult](https://types-mediawiki-response.pages.dev/api/core/ApiProtectResult.md) | The `protect` object of an `action=protect` response. | | | [ApiPurgeEntry](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeEntry.md) | One purged page. | | | [ApiPurgeResponse](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeResponse.md) | Response of `action=purge`. | | | [ApiQueryAuthManagerField](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerField.md) | A single field descriptor of an [ApiQueryAuthManagerInfoRequest](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md). | | | [ApiQueryAuthManagerInfo](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfo.md) | The `authmanagerinfo` object returned under `query`. | | | [ApiQueryAuthManagerInfoRequest](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md) | One AuthManager request descriptor returned by `meta=authmanagerinfo`. | | | [ApiQueryBadRev](https://types-mediawiki-response.pages.dev/api/core/ApiQueryBadRev.md) | One requested `revid` that does not exist, keyed by revision id. | | | [ApiQueryContinue](https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md) | Continuation tokens returned by `action=query`. | | | [ApiQueryInterwikiTitle](https://types-mediawiki-response.pages.dev/api/core/ApiQueryInterwikiTitle.md) | One title resolved to a foreign wiki through an interwiki prefix. | | | [ApiQueryNormalized](https://types-mediawiki-response.pages.dev/api/core/ApiQueryNormalized.md) | One title normalization performed by the query framework. | | | [ApiQueryPage](https://types-mediawiki-response.pages.dev/api/core/ApiQueryPage.md) | The `querypage` container: the requested report and its rows. | | | [ApiQueryPageResult](https://types-mediawiki-response.pages.dev/api/core/ApiQueryPageResult.md) | One row of a report. | | | [ApiQueryResolvedRedirect](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResolvedRedirect.md) | One redirect resolved by the framework (`redirects=1`). | | | [ApiQueryResponse](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md) | Response of `action=query`. `query` widens as modules get covered. | | | [ApiQueryResult](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md) | Accumulated shape of the `query` result object. | | | [ApiQueryTitlePair](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md) | A `{ from, to }` title pair emitted by the query framework. | | | [ApiQueryTokens](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTokens.md) | Tokens returned by `meta=tokens`; which keys appear depends on `type`. | | | [ApiRandomPage](https://types-mediawiki-response.pages.dev/api/core/ApiRandomPage.md) | One randomly selected page. | | | [ApiRateLimit](https://types-mediawiki-response.pages.dev/api/core/ApiRateLimit.md) | A single rate-limit window under `uiprop=ratelimits`. | | | [ApiRawMessage](https://types-mediawiki-response.pages.dev/api/core/ApiRawMessage.md) | An i18n message spec nested inside another message's `params` (`errorformat=raw`) when a parameter is itself a message, serialized as `{ message: ApiRawMessage }`. The nested `params` may recursively contain further messages. | | | [ApiRecentChange](https://types-mediawiki-response.pages.dev/api/core/ApiRecentChange.md) | One recent-changes entry. `rcprop` controls which fields appear. | | | [ApiRedirect](https://types-mediawiki-response.pages.dev/api/core/ApiRedirect.md) | One redirect entry. `rdprop` controls which fields appear. | | | [ApiRemoveAuthenticationDataResponse](https://types-mediawiki-response.pages.dev/api/core/ApiRemoveAuthenticationDataResponse.md) | Response of `action=removeauthenticationdata`. | | | [ApiResetPasswordResponse](https://types-mediawiki-response.pages.dev/api/core/ApiResetPasswordResponse.md) | Response of `action=resetpassword`. | | | [ApiRevision](https://types-mediawiki-response.pages.dev/api/core/ApiRevision.md) | A single revision entry in `pages[].revisions`. | | | [ApiRevisionDeleteItem](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteItem.md) | One item (revision / log entry / image) processed by the request. | | | [ApiRevisionDeleteResponse](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResponse.md) | Response of `action=revisiondelete`. | | | [ApiRevisionDeleteResult](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResult.md) | The `revisiondelete` object of a successful response. | | | [ApiRevisionDiff](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDiff.md) | Diff output attached to a revision (`rvdiffto`/`rvdifftotext`; both request parameters are deprecated — prefer `action=compare`). | | | [ApiRevisionSlot](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlot.md) | One content slot of a revision (a revision may have multiple named slots). | | | [ApiRevisionSlots](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlots.md) | The `slots` map, keyed by slot role. `main` is the default slot; extensions may add others (e.g. `top`, `bottom`). The index signature keeps it open. | | | [ApiRightsInfo](https://types-mediawiki-response.pages.dev/api/core/ApiRightsInfo.md) | `siprop=rightsinfo`: where to read the site's content-rights statement. | | | [ApiRollbackResponse](https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResponse.md) | Response of `action=rollback`. | | | [ApiRollbackResult](https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResult.md) | The `rollback` object of an `action=rollback` response. | | | [ApiSbom](https://types-mediawiki-response.pages.dev/api/core/ApiSbom.md) | Software Bill of Materials in CycloneDX 1.6 form (`siprop=sbom`). Requires a named (logged-in, non-temporary) account. `serialNumber` embeds a fresh UUID per request. | | | [ApiSbomComponent](https://types-mediawiki-response.pages.dev/api/core/ApiSbomComponent.md) | One component of the CycloneDX SBOM (`siprop=sbom`). Components nest: the platform entries carry their PHP extensions, MediaWiki core carries its composer packages and foreign resources, each extension carries its own composer packages. | | | [ApiSearchInfo](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInfo.md) | Per-search metadata (`list=search`'s `searchinfo` sibling). | | | [ApiSearchInterwikiInfo](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiInfo.md) | Total-hit counter of an interwiki search section. | | | [ApiSearchInterwikiResult](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiResult.md) | One interwiki search hit, an element of [ApiQueryResult.interwikisearch](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md#interwikisearch) / [ApiQueryResult.additionalsearch](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md#additionalsearch). Fields follow `srprop` exactly like [ApiSearchResult](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md), except `title` is the bare page name without the namespace, `pageid` is always `0`, and the interwiki namespace/URL fields below are added. | | | [ApiSearchResult](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md) | One search hit (`list=search`), and the page data `generator=search` injects into a `query.pages` entry. | | | [ApiSetNotificationTimestampEntry](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampEntry.md) | One page entry of an `action=setnotificationtimestamp` response. | | | [ApiSetNotificationTimestampResponse](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampResponse.md) | Response of `action=setnotificationtimestamp`. | | | [ApiSetNotificationTimestampWatchlistResult](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampWatchlistResult.md) | Whole-watchlist result (`entirewatchlist=1`): a single object instead of the per-page array. | | | [ApiSetPageLanguageResponse](https://types-mediawiki-response.pages.dev/api/core/ApiSetPageLanguageResponse.md) | Response of `action=setpagelanguage`. | | | [ApiShowHook](https://types-mediawiki-response.pages.dev/api/core/ApiShowHook.md) | One hook and its subscribers (`siprop=showhooks`). | | | [ApiSiteExtension](https://types-mediawiki-response.pages.dev/api/core/ApiSiteExtension.md) | `siprop=extensions`: one installed extension or skin. Keys other than [type](https://types-mediawiki-response.pages.dev/api/core/ApiSiteExtension.md#type) appear only when the component's `extension.json` declares them. | | | [ApiSiteGeneral](https://types-mediawiki-response.pages.dev/api/core/ApiSiteGeneral.md) | Fields of `query.general` (`siprop=general`), closed on the 1.43 core key set — extend by declaration merging for site- or extension-specific keys. | | | [ApiSiteLanguage](https://types-mediawiki-response.pages.dev/api/core/ApiSiteLanguage.md) | One language entry (`siprop=languages`). | | | [ApiSiteRestrictions](https://types-mediawiki-response.pages.dev/api/core/ApiSiteRestrictions.md) | `siprop=restrictions`: protection types and levels. `levels` is **not** a flat string list — FlaggedRevs registers a protection class as a nested array, so an element can be `string[]` (e.g. `["sreview"]`). | | | [ApiSiteSkin](https://types-mediawiki-response.pages.dev/api/core/ApiSiteSkin.md) | One installed skin (`siprop=skins`). | | | [ApiSiteStatistics](https://types-mediawiki-response.pages.dev/api/core/ApiSiteStatistics.md) | Site counters (`siprop=statistics`). | | | [ApiSoftwareLibrary](https://types-mediawiki-response.pages.dev/api/core/ApiSoftwareLibrary.md) | One software component (`siprop=libraries` / `siprop=clientlibraries`). | | | [ApiSpecialPageAlias](https://types-mediawiki-response.pages.dev/api/core/ApiSpecialPageAlias.md) | One localized special-page alias (`siprop=specialpagealiases`). | | | [ApiSpecMessage](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md) | A structured in-band message — a serialized MediaWiki `Message`/`FatalError` spec (`{ message, params, code, type }`) nested inside an action result (e.g. password-policy messages, file-backend errors, AuthManager failures). Distinct from `ApiMessage`, which models the `errorformat`-based envelope. | | | [ApiStashedFile](https://types-mediawiki-response.pages.dev/api/core/ApiStashedFile.md) | One stashed file. `msfprop` controls the measurement fields. | | | [ApiStashEditResponse](https://types-mediawiki-response.pages.dev/api/core/ApiStashEditResponse.md) | Response of `action=stashedit`. | | | [ApiStashImageInfo](https://types-mediawiki-response.pages.dev/api/core/ApiStashImageInfo.md) | Metadata of one stashed file. | | | [ApiTag](https://types-mediawiki-response.pages.dev/api/core/ApiTag.md) | One change-tag definition. `tgprop` selects the optional fields. | | | [ApiTagEntry](https://types-mediawiki-response.pages.dev/api/core/ApiTagEntry.md) | One targeted entry of an `action=tag` response. | | | [ApiTagResponse](https://types-mediawiki-response.pages.dev/api/core/ApiTagResponse.md) | Response of `action=tag`. | | | [ApiTemplate](https://types-mediawiki-response.pages.dev/api/core/ApiTemplate.md) | One page transcluded by the subject page. | | | [ApiThumbUrlEntry](https://types-mediawiki-response.pages.dev/api/core/ApiThumbUrlEntry.md) | One scaled thumbnail entry (a keyed value of [ApiImageInfo.thumburls](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburls)). | | | [ApiTrackingCategory](https://types-mediawiki-response.pages.dev/api/core/ApiTrackingCategory.md) | One tracking-category entry. \`tcprop=size | hidden\` controls the size fields. | | [ApiTranscludedIn](https://types-mediawiki-response.pages.dev/api/core/ApiTranscludedIn.md) | One page in a `transcludedin` result. `tiprop` controls which fields appear. | | | [ApiUnblockResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResponse.md) | Response of `action=unblock`. | | | [ApiUnblockResult](https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResult.md) | The `unblock` object of an `action=unblock` response. | | | [ApiUndeleteResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResponse.md) | Response of `action=undelete`. | | | [ApiUndeleteResult](https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResult.md) | The `undelete` object of an `action=undelete` response. | | | [ApiUploadDialog](https://types-mediawiki-response.pages.dev/api/core/ApiUploadDialog.md) | Upload dialog configuration (`siprop=uploaddialog`), mirroring `$wgUploadDialog` verbatim. | | | [ApiUploadExtMetadataField](https://types-mediawiki-response.pages.dev/api/core/ApiUploadExtMetadataField.md) | A single `extmetadata` field on an uploaded file's imageinfo. | | | [ApiUploadImageinfo](https://types-mediawiki-response.pages.dev/api/core/ApiUploadImageinfo.md) | The embedded `imageinfo` of an `action=upload` result, for the uploaded revision. | | | [ApiUploadMetadataItem](https://types-mediawiki-response.pages.dev/api/core/ApiUploadMetadataItem.md) | One `{ name, value }` metadata entry (values nest for structured types). | | | [ApiUploadResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUploadResponse.md) | Response of `action=upload`. | | | [ApiUploadWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiUploadWarnings.md) | In-band upload warnings (values are strings, string arrays, or objects). | | | [ApiUsedImage](https://types-mediawiki-response.pages.dev/api/core/ApiUsedImage.md) | One image used by a page. | | | [ApiUser](https://types-mediawiki-response.pages.dev/api/core/ApiUser.md) | A user record. `usprop` controls which fields appear. | | | [ApiUserContrib](https://types-mediawiki-response.pages.dev/api/core/ApiUserContrib.md) | One contribution record. `ucprop` controls which fields appear. | | | [ApiUserCore](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md) | Fields present on both the `list=users` ([ApiUser](https://types-mediawiki-response.pages.dev/api/core/ApiUser.md)) and `meta=userinfo` user records; each is gated by the same `usprop`/`uiprop` value in both modules. | | | [ApiUserGroup](https://types-mediawiki-response.pages.dev/api/core/ApiUserGroup.md) | One user group (`siprop=usergroups`). The right-granting lists come from `$wgAddGroups`/`$wgRemoveGroups`/…, so they are absent when unconfigured. | | | [ApiUserGroupMembership](https://types-mediawiki-response.pages.dev/api/core/ApiUserGroupMembership.md) | A single group membership with grant metadata. `usprop=groupmemberships` (vs. the plain name list from `usprop=groups`). | | | [ApiUserInfo](https://types-mediawiki-response.pages.dev/api/core/ApiUserInfo.md) | The `userinfo` object of a `meta=userinfo` response. | | | [ApiUserrightsResponse](https://types-mediawiki-response.pages.dev/api/core/ApiUserrightsResponse.md) | Response of `action=userrights`. | | | [ApiValidatePasswordResponse](https://types-mediawiki-response.pages.dev/api/core/ApiValidatePasswordResponse.md) | Response of `action=validatepassword`. | | | [ApiWarningDetail](https://types-mediawiki-response.pages.dev/api/core/ApiWarningDetail.md) | One `bc`-format warning entry (the value of a module key in `warnings`). | | | [ApiWatchEntry](https://types-mediawiki-response.pages.dev/api/core/ApiWatchEntry.md) | One watched/unwatched page. | | | [ApiWatchlistEntry](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistEntry.md) | One watchlist entry. `wlprop` controls which fields appear. | | | [ApiWatchlistLabel](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md) | A watchlist label (`{ id, name }`), as returned by `meta=userinfo` `uiprop=watchlistlabels`, `prop=info` `inprop=watchlistlabels`, `list=watchlist` `wlprop=labels`, and echoed by `action=watch`. Requires `$wgEnableWatchlistLabels`. Emitted as a list; an empty set serializes as `[]`. | | | [ApiWatchlistRawEntry](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawEntry.md) | One watched title. | | | [ApiWatchlistRawResponse](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawResponse.md) | Response of a query whose only module is `list=watchlistraw`: because the module writes outside `query`, the envelope comes back without a `query` member. | | | [ApiWatchResponse](https://types-mediawiki-response.pages.dev/api/core/ApiWatchResponse.md) | Response of `action=watch`. | | | [ContentModelExtension](https://types-mediawiki-response.pages.dev/api/core/ContentModelExtension.md) | Augmentation target for content models beyond MediaWiki core: extension packs and consumers merge members here (each mapping the model name to itself) to promote them to first-class known values of [ContentModel](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md). | | ## Type Aliases | Type Alias | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [ApiAllusersEntry](https://types-mediawiki-response.pages.dev/api/core/ApiAllusersEntry.md) | One user listed by `list=allusers`. | | [ApiAuthManagerMessage](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) | A message attached to an AuthManager request or field. Its shape follows the request's `amimessageformat` parameter (default `wikitext`): a rendered string under `wikitext`/`html`, an [ApiAuthManagerRawMessage](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerRawMessage.md) under `raw`, and the key is absent under `none`. | | [ApiAuthManagerStatus](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerStatus.md) | AuthManager / password-flow status. The uppercase values are the `AuthenticationResponse` statuses that surface through the API (`PASS`/ `FAIL`/`UI`/`REDIRECT`/`RESTART`; the internal `ABSTAIN` never does); the lowercase `success` is emitted by `ApiResetPassword` itself. Open union. | | [ApiCheckTokenResult](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResult.md) | Result values of [ApiCheckTokenResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md). | | [ApiCodexIcon](https://types-mediawiki-response.pages.dev/api/core/ApiCodexIcon.md) | A Codex icon: raw SVG markup, or a directionality/language-aware definition. | | [ApiErrorResponse](https://types-mediawiki-response.pages.dev/api/core/ApiErrorResponse.md) | An API response describing a failed request (either `errorformat` family). | | [ApiManageTagsOperation](https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsOperation.md) | `action=managetags` operation, echoed from the request. | | [ApiMessageParam](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md) | A single i18n message parameter under `errorformat=raw`: a scalar, a bare nested message ([ApiRawMessage](https://types-mediawiki-response.pages.dev/api/core/ApiRawMessage.md), produced when a message sits inside a list), or an object spec ([ApiMessageParamSpec](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParamSpec.md)). Plain-text parameters are inlined as scalars, and a numeric parameter may arrive as a bare number or a `{ num }` spec. | | [ApiPageExisting](https://types-mediawiki-response.pages.dev/api/core/ApiPageExisting.md) | A `query.pages` entry whose page exists. The framework resolves `pageid`, `ns` and `title` for every existing entry, so they are required here instead of optional as on the merged [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). | | [ApiPageProps](https://types-mediawiki-response.pages.dev/api/core/ApiPageProps.md) | The set of known property values is open-ended and site/extension-specific. | | [ApiPasswordValidity](https://types-mediawiki-response.pages.dev/api/core/ApiPasswordValidity.md) | Password-policy verdict mapped from `checkPasswordValidity`'s Status. Open union. | | [ApiResponseWith](https://types-mediawiki-response.pages.dev/api/core/ApiResponseWith.md) | Discriminated union helper: a response is either successful or an error. | | [ApiSearchHit](https://types-mediawiki-response.pages.dev/api/core/ApiSearchHit.md) | A `list=search` hit. The module writes `ns`, `title` and `pageid` for every hit, before any `srprop` value is considered, so they are required here — unlike [ApiSearchResult](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md), which stays all-optional because `generator=search` merges the same shape into [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) entries. | | [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) | Warnings shape, polymorphic on `errorformat`: `bc` → object keyed by module name; modern → array of [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md). | | [BlockExpiry](https://types-mediawiki-response.pages.dev/api/core/BlockExpiry.md) | Expiry of a block as an action result reports it: a timestamp, or the literal `infinite` for an indefinite block. | | [CaseSensitivity](https://types-mediawiki-response.pages.dev/api/core/CaseSensitivity.md) | Whether/case-sensitivity of page titles in a namespace. Open union for forward compatibility. | | [CategoryMemberType](https://types-mediawiki-response.pages.dev/api/core/CategoryMemberType.md) | Member type (`cmtype` / `gcmtype`). | | [ContentFormat](https://types-mediawiki-response.pages.dev/api/core/ContentFormat.md) | Serialization format of a revision slot, e.g. `text/x-wiki`. **Open union**: known core formats are listed for autocomplete and `(string & {})` keeps the type forward-compatible with extension-provided formats. | | [ContentModel](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) | Content model of a page. **Open union** — known values are autocomplete sugar only; `(string & {})` accepts any model a response may carry. | | [ContributorsPage](https://types-mediawiki-response.pages.dev/api/core/ContributorsPage.md) | A page projected to everything `prop=contributors` contributes, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). | | [Expiry](https://types-mediawiki-response.pages.dev/api/core/Expiry.md) | Expiry of a temporary state: a timestamp, or the literal `infinity` when it does not expire. Block records spell the permanent case `infinite` instead — see [BlockExpiry](https://types-mediawiki-response.pages.dev/api/core/BlockExpiry.md). | | [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) | MediaWiki boolean-style flags: present as `true` when set, otherwise absent. | | [ImageInfoPage](https://types-mediawiki-response.pages.dev/api/core/ImageInfoPage.md) | A page projected to everything `prop=imageinfo` contributes, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). | | [InfoPage](https://types-mediawiki-response.pages.dev/api/core/InfoPage.md) | A page projected to everything `prop=info` contributes, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). | | [InfoPageExisting](https://types-mediawiki-response.pages.dev/api/core/InfoPageExisting.md) | [InfoPage](https://types-mediawiki-response.pages.dev/api/core/InfoPage.md) for a page that exists: the identity fields and the unconditional `prop=info` fields (`PropConstantKeys`) are required; `inprop`-gated fields stay optional. | | [NamespaceIndex](https://types-mediawiki-response.pages.dev/api/core/NamespaceIndex.md) | Namespace index. Negative indexes are pseudo-namespaces. | | [PlainText](https://types-mediawiki-response.pages.dev/api/core/PlainText.md) | A block of plain text (as opposed to HTML), e.g. a TextExtracts excerpt requested with `explaintext`. Kept distinct from HTML-bearing string fields. | | [PropConstantKeys](https://types-mediawiki-response.pages.dev/api/core/PropConstantKeys.md) | `prop=` fields their module writes unconditionally on an existing page. On [QueryPageExisting](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md) these are required when picked; on the all-state [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) they stay optional, because invalid/special entries never carry prop fields. Every other `prop=` key is omitted when its data is absent (empty lists, non-file pages, non-category pages), so it stays optional even on [QueryPageExisting](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md). | | [ProtectedTitleLevel](https://types-mediawiki-response.pages.dev/api/core/ProtectedTitleLevel.md) | Create-protection level of a protected title — an entry of `$wgRestrictionLevels` (core default: `autoconfirmed`, `sysop`). **Open union**: `sreview` comes from FlaggedRevs, so the set is site-dependent. | | [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) | A page scoped to a chosen set of `prop=` fields: identity fields plus the named keys only. Lets callers reflect what they requested and get a compile error when reading a prop they did not ask for. The generator-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index) is included as well, because it comes from the query framework rather than from a `prop=`. | | [QueryPageExisting](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md) | [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) for a page that exists: the identity fields are required rather than optional, and picked `prop=` fields that their module writes unconditionally ([PropConstantKeys](https://types-mediawiki-response.pages.dev/api/core/PropConstantKeys.md)) are required too. See [ApiPageExisting](https://types-mediawiki-response.pages.dev/api/core/ApiPageExisting.md) for when this holds. | | [RecentChangeType](https://types-mediawiki-response.pages.dev/api/core/RecentChangeType.md) | Change type (`rctype`). Open union for forward compatibility. | | [RevisionDeleteStatus](https://types-mediawiki-response.pages.dev/api/core/RevisionDeleteStatus.md) | Per-item outcome. Open union for forward compatibility. | | [SearchPage](https://types-mediawiki-response.pages.dev/api/core/SearchPage.md) | A page projected to the hit fields `generator=search` injects, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). | | [Timestamp](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) | A MediaWiki timestamp in ISO 8601 format (UTC), e.g. `2024-01-15T08:30:00Z`. | | [WatchlistExpiry](https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md) | Expiry of a watch: a timestamp, or `null` when the page is not watched or the watch is permanent. | --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAcceptLang.md --- > 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: ApiAcceptLang Defined in: [core/query/userinfo.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L17) One entry of the `acceptlang` list (a browser `Accept-Language` parse). ## Properties ### code? > `optional` **code?**: `string` Defined in: [core/query/userinfo.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L22) Language code, or `*` for the fallback. `uiprop=acceptlang`. *** ### q? > `optional` **q?**: `number` Defined in: [core/query/userinfo.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L19) Quality factor (0–1). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAcquireTempUserNameResponse.md --- > 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: ApiAcquireTempUserNameResponse Defined in: [core/acquiretempusername.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/acquiretempusername.ts#L15) Response of `action=acquiretempusername`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### acquiretempusername? > `optional` **acquiretempusername?**: `string` Defined in: [core/acquiretempusername.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/acquiretempusername.ts#L17) The stashed temporary username (e.g. `~2024-9`). *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiActionPermission.md --- > 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: ApiActionPermission Defined in: [core/query/info.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L44) One permission-check failure reported under `intestactionsdetail=full|quick`. The text-bearing keys depend on the request's `errorformat`: `text` for `plaintext`/`wikitext`, `html` for `html`, `key`/`params` for `raw`, and none of them for `none`. A request using the default (`bc`) format is rendered as `plaintext` here. ## Properties ### code > **code**: `string` Defined in: [core/query/info.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L46) Machine-readable code, e.g. `sitejsprotected`. *** ### html? > `optional` **html?**: `string` Defined in: [core/query/info.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L52) Parsed message HTML (`html`). *** ### key? > `optional` **key?**: `string` Defined in: [core/query/info.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L55) i18n message key (`raw`). *** ### params? > `optional` **params?**: [`ApiMessageParam`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md)\[] Defined in: [core/query/info.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L58) i18n message parameters (`raw`). *** ### text? > `optional` **text?**: `string` Defined in: [core/query/info.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L49) Rendered message text (`plaintext`/`wikitext`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md --- > 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: ApiAllCategory Defined in: [core/query/allcategories.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L9) One category summary. `acprop=size|hidden` selects the optional fields. ## Extended by - [`ApiTrackingCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiTrackingCategory.md) ## Properties ### category > **category**: `string` Defined in: [core/query/allcategories.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L11) Category name, without the `Category:` prefix. *** ### files? > `optional` **files?**: `number` Defined in: [core/query/allcategories.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L20) Number of files. `acprop=size`. *** ### hidden? > `optional` **hidden?**: `boolean` Defined in: [core/query/allcategories.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L26) Whether the category is hidden. `acprop=hidden`; a real `boolean`. *** ### pages? > `optional` **pages?**: `number` Defined in: [core/query/allcategories.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L17) Number of pages. `acprop=size`. *** ### size? > `optional` **size?**: `number` Defined in: [core/query/allcategories.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L14) Total members (pages + subcats + files). `acprop=size`. *** ### subcats? > `optional` **subcats?**: `number` Defined in: [core/query/allcategories.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L23) Number of subcategories. `acprop=size`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllDeletedRevisions.md --- > 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: ApiAllDeletedRevisions Defined in: [core/query/alldeletedrevisions.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alldeletedrevisions.ts#L15) One page carrying at least one deleted revision. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/alldeletedrevisions.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alldeletedrevisions.ts#L17) Page id; `0` when the whole page is deleted. #### Overrides [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### revisions > **revisions**: `ApiRevision`\[] Defined in: [core/query/alldeletedrevisions.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alldeletedrevisions.ts#L20) The page's deleted revisions, ordered per `ardir` (default `older`). *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllImage.md --- > 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: ApiAllImage Defined in: [core/query/allimages.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allimages.ts#L13) One file listed by `list=allimages`. ## Extends - [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md) ## Properties ### anon? > `optional` **anon?**: `true` Defined in: [core/query/imageinfo.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L237) Made by an anonymous (IP) uploader. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`anon`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#anon) *** ### archivename? > `optional` **archivename?**: `string` Defined in: [core/query/imageinfo.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L231) Archive name for a historical version. `iiprop=archivename`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`archivename`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#archivename) *** ### bitdepth? > `optional` **bitdepth?**: `number` Defined in: [core/query/imageinfo.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L174) Color bit depth; `0` for files without dimensions (e.g. audio). `iiprop=bitdepth`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`bitdepth`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#bitdepth) *** ### canonicaltitle? > `optional` **canonicaltitle?**: `string` Defined in: [core/query/imageinfo.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L110) Canonical localized file title. `iiprop=canonicaltitle`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`canonicaltitle`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#canonicaltitle) *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/imageinfo.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L89) Raw upload comment. `iiprop=comment`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`comment`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#comment) *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#commenthidden) *** ### commonmetadata? > `optional` **commonmetadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] Defined in: [core/query/imageinfo.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L186) Metadata keys common to all file types, same item shape as [metadata](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#metadata). `iiprop=commonmetadata`; an empty PHP map, so `[]` when there is none. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`commonmetadata`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#commonmetadata) *** ### descriptionshorturl? > `optional` **descriptionshorturl?**: `string` Defined in: [core/query/imageinfo.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L119) Shortened description-page URL. `iiprop=url`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`descriptionshorturl`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#descriptionshorturl) *** ### descriptionurl? > `optional` **descriptionurl?**: `string` Defined in: [core/query/imageinfo.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L116) URL of the file description page. `iiprop=url`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`descriptionurl`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#descriptionurl) *** ### duration? > `optional` **duration?**: `number` Defined in: [core/query/imageinfo.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L221) Media duration in seconds (audio/video), when the handler reports one. Emitted under `iiprop=size|dimensions`; there is no `iiprop=duration`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`duration`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#duration) *** ### extmetadata? > `optional` **extmetadata?**: `Record`\<`string`, [`ApiExtMetadataField`](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataField.md)> Defined in: [core/query/imageinfo.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L194) Structured/extended metadata keyed by field name. `iiprop=extmetadata`. A bare MediaWiki core only produces `DateTime` and `ObjectName` here; the richer per-file fields (GPS, licensing, …) are contributed by `GetExtendedMetadata` hooks on the serving wiki (e.g. Extension:Metadata). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`extmetadata`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#extmetadata) *** ### filehidden? > `optional` **filehidden?**: `true` Defined in: [core/query/imageinfo.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L234) The file itself is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`filehidden`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#filehidden) *** ### filemissing? > `optional` **filemissing?**: `true` Defined in: [core/query/imageinfo.ts:215](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L215) `true` when the file itself does not exist on this wiki (a stub row). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`filemissing`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#filemissing) *** ### height? > `optional` **height?**: `number` Defined in: [core/query/imageinfo.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L107) Height in pixels; `0` for files without dimensions (e.g. audio). `iiprop=size|dimensions`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`height`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#height) *** ### html? > `optional` **html?**: `string` Defined in: [core/query/imageinfo.ts:212](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L212) Upload-warning HTML ("a file with this name exists already…"). `iiprop=uploadwarning`; `""` when there is nothing to warn about. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`html`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#html) *** ### mediatype? > `optional` **mediatype?**: `string` Defined in: [core/query/imageinfo.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L171) Media type, e.g. `BITMAP`, `OFFICE`, `ARCHIVE`. `iiprop=mediatype`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`mediatype`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#mediatype) *** ### metadata? > `optional` **metadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] | `null` Defined in: [core/query/imageinfo.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L180) Raw format metadata (EXIF / PNG chunks / …). `iiprop=metadata`; an explicit `null` when the file has no metadata at all. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`metadata`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#metadata) *** ### mime? > `optional` **mime?**: `string` Defined in: [core/query/imageinfo.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L168) MIME type, e.g. `image/png`. `iiprop=mime`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`mime`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#mime) *** ### name > **name**: `string` Defined in: [core/query/allimages.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allimages.ts#L15) File name without the `File:` prefix. *** ### ns > **ns**: `number` Defined in: [core/query/allimages.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allimages.ts#L18) Namespace index (the File namespace, 6). *** ### pagecount? > `optional` **pagecount?**: `number` Defined in: [core/query/imageinfo.ts:228](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L228) Page count (multi-page documents such as PDFs/TIFFs), when the handler supports one. Emitted under `iiprop=size|dimensions`; there is no `iiprop=pagecount`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`pagecount`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#pagecount) *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/imageinfo.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L92) HTML-rendered comment. `iiprop=parsedcomment`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`parsedcomment`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#parsedcomment) *** ### responsiveUrls? > `optional` **responsiveUrls?**: `Record`\<`string`, `string`> Defined in: [core/query/imageinfo.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L162) HiDPI (`2x`, …) source URLs keyed by pixel-density multiplier. Requires `iiprop=url`, plus a successful transform. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`responsiveUrls`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#responsiveurls) *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/imageinfo.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L165) File SHA-1 (hex). `iiprop=sha1`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`sha1`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#sha1) *** ### size? > `optional` **size?**: `number` Defined in: [core/query/imageinfo.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L95) File size in bytes. `iiprop=size|dimensions`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`size`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#size) *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#suppressed) *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/imageinfo.ts:244](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L244) The uploader is a temporary account. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`temp`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#temp) *** ### thumbattribs? > `optional` **thumbattribs?**: `Record`\<`string`, `string` | `number`> Defined in: [core/query/imageinfo.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L146) Pre-rendered `` attributes for the thumbnail (e.g. `src`, `width`, `srcset`). #### Since MediaWiki 1.47 #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbattribs`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbattribs) *** ### thumberror? > `optional` **thumberror?**: `string` Defined in: [core/query/imageinfo.ts:206](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L206) Rendered text of the thumbnail error, when the thumbnail could not be made. Requires `iiprop=url`, plus a transform. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumberror`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumberror) *** ### thumbheight? > `optional` **thumbheight?**: `number` Defined in: [core/query/imageinfo.ts:138](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L138) Scaled thumbnail height (px). Falls back to the file's own height like [thumbwidth](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbwidth). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbheight`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbheight) *** ### thumbmime? > `optional` **thumbmime?**: `string` Defined in: [core/query/imageinfo.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L200) MIME type the thumbnail will be rendered as. `iiprop=thumbmime`, which requires `iiprop=url` and a transform via `iiurlwidth`/`iiurlheight`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbmime`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbmime) *** ### thumburl? > `optional` **thumburl?**: `string` Defined in: [core/query/imageinfo.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L125) Scaled thumbnail URL. Requires `iiprop=url`, plus a transform requested via `iiurlwidth`, `iiurlheight` or `iiurlparam`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumburl`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburl) *** ### thumburls? > `optional` **thumburls?**: `Record`\<`string`, [`ApiThumbUrlEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiThumbUrlEntry.md)> Defined in: [core/query/imageinfo.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L156) Scaled thumbnail URLs at multiple widths, keyed by the produced thumbnail's width (normally the requested width; e.g. `"400"`, `"800"`). `iiprop=thumburls`. Each entry also folds in the transform's HTML `` attributes. #### Since MediaWiki 1.47 #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumburls`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburls) *** ### thumbwidth? > `optional` **thumbwidth?**: `number` Defined in: [core/query/imageinfo.ts:132](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L132) Scaled thumbnail width (px). Falls back to the file's own width when the thumbnail URL equals the original URL (no resize happened). Same requirements as [thumburl](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburl). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbwidth`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbwidth) *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/imageinfo.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L80) Timestamp of the file's upload/reversion. `iiprop=timestamp`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`timestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#timestamp) *** ### title > **title**: `string` Defined in: [core/query/allimages.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allimages.ts#L21) Full file title, e.g. `File:Wiki.png`. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/imageinfo.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L113) Direct URL to the file. `iiprop=url`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`url`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#url) *** ### user? > `optional` **user?**: `string` Defined in: [core/query/imageinfo.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L83) Uploader user name. `iiprop=user`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`user`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#user) *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/imageinfo.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L86) Uploader user id. `iiprop=userid`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`userid`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#userid) *** ### width? > `optional` **width?**: `number` Defined in: [core/query/imageinfo.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L101) Width in pixels; `0` for files without dimensions (e.g. audio). `iiprop=size|dimensions`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`width`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#width) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllLink.md --- > 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: ApiAllLink Defined in: [core/query/alllinks.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alllinks.ts#L14) One linked (or redirected-to / transcluded) title. ## Properties ### fragment? > `optional` **fragment?**: `string` Defined in: [core/query/allredirects.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allredirects.ts#L14) Fragment of the redirect target title. `arprop=fragment`. *** ### fromid? > `optional` **fromid?**: `number` Defined in: [core/query/alllinks.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alllinks.ts#L21) Page id of the page holding the link (`alprop=ids`). Without `alunique` a target appears once per linking page, each row carrying that page's id; `alunique` lists each target once and drops the source page id, so it cannot be combined with `*prop=ids`. *** ### interwiki? > `optional` **interwiki?**: `string` Defined in: [core/query/allredirects.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allredirects.ts#L17) Interwiki prefix of the redirect target, when it points off-site. `arprop=interwiki`. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/alllinks.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alllinks.ts#L24) Namespace index of the linked title. `alprop=title` (default). *** ### title? > `optional` **title?**: `string` Defined in: [core/query/alllinks.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alllinks.ts#L27) Full title of the linked page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllMessage.md --- > 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: ApiAllMessage Defined in: [core/query/allmessages.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L13) One interface message. ## Properties ### content? > `optional` **content?**: `string` Defined in: [core/query/allmessages.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L24) Message body. Absent when the message does not exist. *** ### customised? > `optional` **customised?**: `true` Defined in: [core/query/allmessages.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L40) Present only when filtering with `amcustomised=modified`, which restricts the result to customised messages, so always `true`. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### default? > `optional` **default?**: `string` Defined in: [core/query/allmessages.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L27) Default (untranslated) value. `amprop=default`. *** ### defaultmissing? > `optional` **defaultmissing?**: `true` Defined in: [core/query/allmessages.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L34) The message exists on the wiki (e.g. a custom `MediaWiki:` page) but the software ships no built-in default for it. Emitted instead of [default](#default) under `amprop=default`. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/allmessages.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L43) `true` when the message is not defined. *** ### name > **name**: `string` Defined in: [core/query/allmessages.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L15) Message key. *** ### normalizedname > **normalizedname**: `string` Defined in: [core/query/allmessages.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L21) Key normalized for lookup: first letter lowercased and spaces replaced with underscores. Emitted on every entry, independent of `amprop`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllPage.md --- > 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: ApiAllPage Defined in: [core/query/allpages.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allpages.ts#L11) One page listed by `list=allpages`. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllRevisions.md --- > 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: ApiAllRevisions Defined in: [core/query/allrevisions.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allrevisions.ts#L16) One page with the revisions requested for it. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### revisions > **revisions**: `ApiRevision`\[] Defined in: [core/query/allrevisions.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allrevisions.ts#L18) Revisions of the page, ordered per `arvdir`. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAllusersEntry.md --- > 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. # Type Alias: ApiAllusersEntry > **ApiAllusersEntry** = `Omit`\<[`ApiUser`](https://types-mediawiki-response.pages.dev/api/core/ApiUser.md), `"gender"` | `"emailable"` | `"cancreate"` | `"cancreateerror"` | `"groupmemberships"` | `"missing"` | `"systemuser"` | `"userid"` | `"name"`> & `object` Defined in: [core/query/allusers.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allusers.ts#L16) One user listed by `list=allusers`. ## Type Declaration ### name > **name**: `string` User name. ### recentactions? > `optional` **recentactions?**: `number` Effective actions over the last `$wgActiveUserDays` days. Emitted only with `auactiveusers=1`. ### registration? > `optional` **registration?**: [`Timestamp`](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) | `""` Registration timestamp, or an **empty string** for accounts created before registration timestamps were tracked (unlike the `null` of `list=users`). `auprop=registration`. ### userid > **userid**: `number` User id. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md --- > 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. # Type Alias: ApiAuthManagerMessage > **ApiAuthManagerMessage** = `string` | [`ApiAuthManagerRawMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerRawMessage.md) Defined in: [core/query/authmanagerinfo.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L15) A message attached to an AuthManager request or field. Its shape follows the request's `amimessageformat` parameter (default `wikitext`): a rendered string under `wikitext`/`html`, an [ApiAuthManagerRawMessage](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerRawMessage.md) under `raw`, and the key is absent under `none`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerRawMessage.md --- > 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: ApiAuthManagerRawMessage Defined in: [core/query/authmanagerinfo.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L18) A message in raw form (`amimessageformat=raw`): the i18n key plus parameters. ## Properties ### key? > `optional` **key?**: `string` Defined in: [core/query/authmanagerinfo.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L20) i18n message key. *** ### params? > `optional` **params?**: `unknown`\[] Defined in: [core/query/authmanagerinfo.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L23) i18n message parameters. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerStatus.md --- > 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. # Type Alias: ApiAuthManagerStatus > **ApiAuthManagerStatus** = `"PASS"` | `"FAIL"` | `"UI"` | `"REDIRECT"` | `"RESTART"` | `"success"` | `string` & `object` Defined in: [core/query/authmanagerinfo.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L32) AuthManager / password-flow status. The uppercase values are the `AuthenticationResponse` statuses that surface through the API (`PASS`/ `FAIL`/`UI`/`REDIRECT`/`RESTART`; the internal `ABSTAIN` never does); the lowercase `success` is emitted by `ApiResetPassword` itself. Open union. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAutoCreateTempUser.md --- > 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: ApiAutoCreateTempUser Defined in: [core/query/siteinfo.ts:697](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L697) Temporary-account creation config (`siprop=autocreatetempuser`). ## Properties ### enabled > **enabled**: `boolean` Defined in: [core/query/siteinfo.ts:703](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L703) Whether automatic temporary-account creation is on. A real `boolean`. #### Since MediaWiki 1.41 *** ### matchPatterns? > `optional` **matchPatterns?**: `string`\[] Defined in: [core/query/siteinfo.ts:710](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L710) Name patterns reserved for temporary accounts; only when configured. #### Since MediaWiki 1.43 --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md --- > 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: ApiAutopromoteCondition Defined in: [core/query/siteinfo.ts:661](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L661) One autopromote condition. A group's set is an **object with numeric keys** under fv2 (the PHP array also carries `operand`), so nested sets surface as `"0"`, `"1"`, … entries alongside [operand](#operand). ## Indexable > \[`position`: `string`]: `string` | `unknown`\[] | `ApiAutopromoteCondition` | `undefined` Nested condition sets, keyed by position. ## Properties ### condname? > `optional` **condname?**: `string` Defined in: [core/query/siteinfo.ts:663](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L663) Condition constant name, e.g. `APCOND_EDITCOUNT`. *** ### operand? > `optional` **operand?**: `string` Defined in: [core/query/siteinfo.ts:669](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L669) Operator combining the set: `&`, `|`, `^`, or `!`. *** ### params? > `optional` **params?**: `unknown`\[] Defined in: [core/query/siteinfo.ts:666](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L666) Arguments for the condition (counts in days, edits, …). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteConditions.md --- > 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: ApiAutopromoteConditions Defined in: [core/query/siteinfo.ts:681](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L681) Autopromote condition sets keyed by group name (`siprop=autopromote`). A full condition set arrives as a single [ApiAutopromoteCondition](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md) carrying an `operand`; a single-condition or bare-string configuration arrives wrapped in a one-element array. ## Indexable > \[`group`: `string`]: `string`\[] | [`ApiAutopromoteCondition`](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md) | [`ApiAutopromoteCondition`](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteCondition.md)\[] | `undefined` Condition set for the group the key names. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteOnce.md --- > 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: ApiAutopromoteOnce Defined in: [core/query/siteinfo.ts:691](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L691) Autopromote-once configuration keyed by hook name (`siprop=autopromoteonce`). A hook with nothing configured arrives as an empty **array**, because `formatversion=2` cannot tell an empty PHP list from an empty map. ## Indexable > \[`hook`: `string`]: `unknown`\[] | [`ApiAutopromoteConditions`](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteConditions.md) | `undefined` Condition groups for the hook the key names; `[]` when none is configured. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBacklink.md --- > 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: ApiBacklink Defined in: [core/query/backlinks.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/backlinks.ts#L16) One page that links to the target title. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/backlinks.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/backlinks.ts#L18) The linking page is itself a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### redirlinks? > `optional` **redirlinks?**: `ApiBacklink`\[] Defined in: [core/query/backlinks.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/backlinks.ts#L24) Pages that link through this redirect to the target title. Only on a `redirect` entry, and only with `blredirect=1`. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBcErrorResponse.md --- > 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: ApiBcErrorResponse Defined in: [envelope/index.ts:203](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L203) Error response under the default (`bc`) `errorformat`: a single `error` object. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### error > **error**: [`ApiError`](https://types-mediawiki-response.pages.dev/api/core/ApiError.md) Defined in: [envelope/index.ts:205](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L205) The error that made the request fail. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBlock.md --- > 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: ApiBlock Defined in: [core/query/blocks.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L32) One block record. `bkprop` controls which fields appear. ## Properties ### allowusertalk? > `optional` **allowusertalk?**: `boolean` Defined in: [core/query/blocks.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L117) Blocked user may still edit their own talk page. `bkprop=flags`. *** ### anononly? > `optional` **anononly?**: `boolean` Defined in: [core/query/blocks.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L100) Blocks anonymous (edit-only) users. `bkprop=flags`. *** ### autoblock? > `optional` **autoblock?**: `boolean` Defined in: [core/query/blocks.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L104) Autoblock enabled for the offending IP. `bkprop=flags`. *** ### automatic? > `optional` **automatic?**: `boolean` Defined in: [core/query/blocks.ts:98](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L98) Applied automatically by the autoblock feature. `bkprop=flags`. *** ### block-hidden? > `optional` **block-hidden?**: `boolean` Defined in: [core/query/blocks.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L115) Suppression visibility of the block. `bkprop=flags`. Written as a separate key alongside [hidden](#hidden), with the same value (the block is oversighted). #### Since MediaWiki 1.46 *** ### by? > `optional` **by?**: `string` Defined in: [core/query/blocks.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L49) Name of the admin who applied the block. `bkprop=by`. *** ### byid? > `optional` **byid?**: `number` Defined in: [core/query/blocks.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L52) User id of the blocking admin. `bkprop=byid`. *** ### duration-l10n? > `optional` **duration-l10n?**: `string` Defined in: [core/query/blocks.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L66) Human-readable duration, e.g. `3 months`, or the localized "infinite" message for a permanent block. `bkprop=expiry`. #### Since MediaWiki 1.44 *** ### expiry? > `optional` **expiry?**: `string` Defined in: [core/query/blocks.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L58) When the block expires, or `infinity`. `bkprop=expiry`. *** ### hidden? > `optional` **hidden?**: `boolean` Defined in: [core/query/blocks.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L108) Block is hidden from the block log. `bkprop=flags`. *** ### id? > `optional` **id?**: `number` Defined in: [core/query/blocks.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L34) Block id. `bkprop=id`. *** ### nocreate? > `optional` **nocreate?**: `boolean` Defined in: [core/query/blocks.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L102) Prevents account creation. `bkprop=flags`. *** ### noemail? > `optional` **noemail?**: `boolean` Defined in: [core/query/blocks.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L106) Prevents sending email. `bkprop=flags`. *** ### parsedreason? > `optional` **parsedreason?**: `string` Defined in: [core/query/blocks.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L77) HTML-rendered block reason. `bkprop=parsedreason`; the 1.43 baseline rejects that value, so it only appears on newer wikis. #### Since MediaWiki 1.44 *** ### partial? > `optional` **partial?**: `boolean` Defined in: [core/query/blocks.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L119) Whether this is a partial block. `bkprop=flags`. *** ### rangeend? > `optional` **rangeend?**: `string` Defined in: [core/query/blocks.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L89) End of the blocked IP range (hex form). `bkprop=range` on a range block; before 1.43 also emitted for single-IP blocks. *** ### rangestart? > `optional` **rangestart?**: `string` Defined in: [core/query/blocks.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L83) Start of the blocked IP range (hex form). `bkprop=range` on a range block; before 1.43 also emitted for single-IP blocks. *** ### reason? > `optional` **reason?**: `string` Defined in: [core/query/blocks.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L69) Raw block reason. `bkprop=reason`. *** ### restrictions? > `optional` **restrictions?**: `unknown`\[] | [`ApiBlockRestrictions`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockRestrictions.md) Defined in: [core/query/blocks.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L95) Restriction targets of a partial block, grouped by kind; `[]` for a sitewide block. `bkprop=restrictions`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/blocks.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L55) When the block was applied. `bkprop=timestamp`. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/blocks.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L40) Blocked user name, IP address or IP range; absent for every autoblock. `bkprop=user`. *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/blocks.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L46) Blocked user id; `0` when the target is an IP address or IP range, absent for every autoblock. `bkprop=userid`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md --- > 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: ApiBlockInfo Defined in: [core/query/users.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L15) Block details, as emitted for `usprop=blockinfo` (list=users) and `uiprop=blockinfo` (meta=userinfo). Only present when the user is blocked. The same shape is shared by [ApiUser.blockcomponents](#blockcomponents) entries. ## Extended by - [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md) ## Properties ### blockanononly? > `optional` **blockanononly?**: `boolean` Defined in: [core/query/users.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L52) Whether the block only affects anonymous users (soft block). A real `boolean`. *** ### blockautoblocking? > `optional` **blockautoblocking?**: `boolean` Defined in: [core/query/users.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L83) Whether the block also enables the autoblock feature. A real `boolean`. #### Since MediaWiki 1.46 *** ### blockcomponents? > `optional` **blockcomponents?**: `ApiBlockInfo`\[] Defined in: [core/query/users.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L76) The individual blocks composing this one; only for composite blocks. #### Since MediaWiki 1.42 *** ### blockedby? > `optional` **blockedby?**: `string` Defined in: [core/query/users.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L20) User name of the blocker; `''` when unknown (e.g. autoblocks). *** ### blockedbyid? > `optional` **blockedbyid?**: `number` Defined in: [core/query/users.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L23) User id of the blocker; `0` when unknown. *** ### blockedtimestamp? > `optional` **blockedtimestamp?**: `string` Defined in: [core/query/users.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L29) When the block was placed or last modified. *** ### blockedtimestampformatted? > `optional` **blockedtimestampformatted?**: `string` Defined in: [core/query/users.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L34) `blockedtimestamp` localized for the requesting user. *** ### blockemail? > `optional` **blockemail?**: `boolean` Defined in: [core/query/users.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L59) Whether the block prevents sending email. A real `boolean`. #### Since MediaWiki 1.41 *** ### blockexpiry? > `optional` **blockexpiry?**: `string` Defined in: [core/query/users.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L37) Block expiry; the literal `infinite` when the block does not expire. *** ### blockexpiryformatted? > `optional` **blockexpiryformatted?**: `string` Defined in: [core/query/users.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L40) `blockexpiry` localized for the requesting user; only when the block expires. *** ### blockexpiryrelative? > `optional` **blockexpiryrelative?**: `string` Defined in: [core/query/users.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L43) Human-readable time to expiry (e.g. `in 5 days`); only when the block expires. *** ### blockhidden? > `optional` **blockhidden?**: `true` Defined in: [core/query/users.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L91) The block itself is suppressed (hidden from users without the `hideuser` right). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md), present only when suppressed. #### Since MediaWiki 1.47 *** ### blockid? > `optional` **blockid?**: `number` Defined in: [core/query/users.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L17) ID of the block. *** ### blocknocreate? > `optional` **blocknocreate?**: `boolean` Defined in: [core/query/users.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L49) Whether the block prevents account creation. A real `boolean`. *** ### blockowntalk? > `optional` **blockowntalk?**: `boolean` Defined in: [core/query/users.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L66) Whether editing one's own talk page is prevented. A real `boolean`. #### Since MediaWiki 1.41 *** ### blockpartial? > `optional` **blockpartial?**: `boolean` Defined in: [core/query/users.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L46) Whether the block only applies to certain pages, namespaces and/or actions. A real `boolean`. *** ### blockreason? > `optional` **blockreason?**: `string` Defined in: [core/query/users.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L26) Block reason, in plain text. *** ### systemblocktype? > `optional` **systemblocktype?**: `string` Defined in: [core/query/users.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L69) Type of the automatically applied system block; only for system blocks. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBlockResponse.md --- > 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: ApiBlockResponse Defined in: [core/block.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L89) Response of `action=block`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### block > **block**: [`ApiBlockResult`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockResult.md) Defined in: [core/block.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L91) Result of `action=block`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBlockRestrictions.md --- > 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: ApiBlockRestrictions Defined in: [core/query/blocks.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L11) Restriction targets of a partial block, grouped by kind. ## Properties ### actions? > `optional` **actions?**: `string`\[] Defined in: [core/query/blocks.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L28) Restricted actions; only on action-type entries. Before MediaWiki 1.45 these require `$wgEnablePartialActionBlocks`. *** ### namespaces? > `optional` **namespaces?**: `number`\[] Defined in: [core/query/blocks.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L25) Restricted namespace ids. *** ### pages? > `optional` **pages?**: `object`\[] Defined in: [core/query/blocks.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L13) Restricted pages. #### id > **id**: `number` Page id. #### ns? > `optional` **ns?**: `number` Namespace index of the restricted page. #### title? > `optional` **title?**: `string` Full title of the restricted page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiBlockResult.md --- > 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: ApiBlockResult Defined in: [core/block.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L16) The `block` object of an `action=block` response. ## Properties ### actionrestrictions? > `optional` **actionrestrictions?**: `string`\[] | `null` Defined in: [core/block.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L70) Restricted actions of a partial action block; `null` when the block restricts no actions. Only emitted on MediaWiki 1.39–1.44 when `$wgEnablePartialActionBlocks` is on. *** ### additionalBlocksStatuses? > `optional` **additionalBlocksStatuses?**: `unknown`\[] | `Record`\<`string`, `unknown`> Defined in: [core/block.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L85) Extra statuses set by extensions during a successful block; `[]` when none is set. #### Since MediaWiki 1.46 *** ### allowusertalk > **allowusertalk**: `boolean` Defined in: [core/block.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L48) Let the blocked user keep editing their own user talk page. *** ### anononly > **anononly**: `boolean` Defined in: [core/block.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L33) Block only anonymous users editing from an IP address range. *** ### autoblock > **autoblock**: `boolean` Defined in: [core/block.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L39) Also block the IP addresses this user edits from. *** ### expiry > **expiry**: `string` Defined in: [core/block.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L27) Expiry timestamp, or `infinite` for an indefinite block. *** ### hidename > **hidename**: `boolean` Defined in: [core/block.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L45) Hide the username in logs and contributions. *** ### id > **id**: `number` Defined in: [core/block.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L24) Block id. *** ### namespacerestrictions > **namespacerestrictions**: `number`\[] | `null` Defined in: [core/block.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L60) Namespace restrictions of a partial block; `null` when sitewide. *** ### nocreate > **nocreate**: `boolean` Defined in: [core/block.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L36) Prevent new account creation from the blocked user or IP range. *** ### noemail > **noemail**: `boolean` Defined in: [core/block.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L42) Prevent the user from sending email via `Special:Emailuser`. *** ### pagerestrictions > **pagerestrictions**: `string`\[] | `null` Defined in: [core/block.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L57) Page restrictions of a partial block; `null` when sitewide. *** ### partial > **partial**: `boolean` Defined in: [core/block.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L54) Restrict the block to specific pages or namespaces instead of sitewide. *** ### reason > **reason**: `string` Defined in: [core/block.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L30) Block reason (echoed back). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/block.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L77) When the block was applied, in ISO 8601. #### Since MediaWiki 1.47 *** ### user > **user**: `string` Defined in: [core/block.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L18) Blocked user name / IP. *** ### userID > **userID**: `number` Defined in: [core/block.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L21) Blocked user id (`0` for IPs / autoblocks). Note the capital `D`. *** ### watchlistexpiry? > `optional` **watchlistexpiry?**: [`WatchlistExpiry`](https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md) Defined in: [core/block.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L63) Expiry applied to the watched user page. *** ### watchuser > **watchuser**: `boolean` Defined in: [core/block.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/block.ts#L51) Add the blocked user's user and talk pages to the blocker's watchlist. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCategory.md --- > 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: ApiCategory Defined in: [core/query/categories.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L10) One category membership entry; `clprop` selects the optional fields. ## Properties ### hidden? > `optional` **hidden?**: `boolean` Defined in: [core/query/categories.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L27) Whether the category is hidden. `clprop=hidden`; a real `boolean` (not a `Flag`). *** ### ns > **ns**: `number` Defined in: [core/query/categories.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L12) Namespace index (the Category namespace, 14). *** ### sortkey? > `optional` **sortkey?**: `string` Defined in: [core/query/categories.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L18) Raw (hex) sort key. `clprop=sortkey`. *** ### sortkeyprefix? > `optional` **sortkeyprefix?**: `string` Defined in: [core/query/categories.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L21) Human-readable sort key prefix. `clprop=sortkey`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/categories.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L24) When the page was added to the category. `clprop=timestamp`. *** ### title > **title**: `string` Defined in: [core/query/categories.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L15) Full category title, e.g. `Category:Manual`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCategoryInfo.md --- > 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: ApiCategoryInfo Defined in: [core/query/categoryinfo.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L9) Category size statistics (`prop=categoryinfo`). ## Properties ### files > **files**: `number` Defined in: [core/query/categoryinfo.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L17) Number of files. *** ### hidden > **hidden**: `boolean` Defined in: [core/query/categoryinfo.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L23) Whether the category is a hidden category. A real `boolean`. *** ### pages > **pages**: `number` Defined in: [core/query/categoryinfo.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L14) Number of content pages, excluding both subcategories and files. *** ### size > **size**: `number` Defined in: [core/query/categoryinfo.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L11) Total member count: pages + subcategories + files (the raw `cat_pages` counter). *** ### subcats > **subcats**: `number` Defined in: [core/query/categoryinfo.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L20) Number of subcategories. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCategoryMember.md --- > 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: ApiCategoryMember Defined in: [core/query/categorymembers.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L17) One category member. `cmprop` controls which fields appear. ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [core/query/categorymembers.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L22) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/categorymembers.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L19) Page id. `cmprop=ids`. *** ### sortkey? > `optional` **sortkey?**: `string` Defined in: [core/query/categorymembers.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L28) Raw (hex) sort key. `cmprop=sortkey`. *** ### sortkeyprefix? > `optional` **sortkeyprefix?**: `string` Defined in: [core/query/categorymembers.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L31) Human-readable sort key prefix. `cmprop=sortkeyprefix`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/categorymembers.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L37) When the page was added to the category. `cmprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/categorymembers.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L25) Full page title. *** ### type? > `optional` **type?**: [`CategoryMemberType`](https://types-mediawiki-response.pages.dev/api/core/CategoryMemberType.md) Defined in: [core/query/categorymembers.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L34) Member type. `cmprop=type`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiChangeAuthenticationDataResponse.md --- > 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: ApiChangeAuthenticationDataResponse Defined in: [core/changeauthenticationdata.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/changeauthenticationdata.ts#L14) Response of `action=changeauthenticationdata`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### changeauthenticationdata > **changeauthenticationdata**: `object` Defined in: [core/changeauthenticationdata.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/changeauthenticationdata.ts#L16) Result of `action=changeauthenticationdata`. #### status > **status**: `"success"` Flow outcome; `success` when the change was applied. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiChangeContentModelResponse.md --- > 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: ApiChangeContentModelResponse Defined in: [core/changecontentmodel.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/changecontentmodel.ts#L13) Response of `action=changecontentmodel`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### changecontentmodel > **changecontentmodel**: `object` Defined in: [core/changecontentmodel.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/changecontentmodel.ts#L15) Result of `action=changecontentmodel`. #### contentmodel > **contentmodel**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) The content model now in effect. #### logid > **logid**: `number` Log entry id recorded for the change. #### pageid > **pageid**: `number` Page id. #### result > **result**: `"Success"` `Success` when the model was changed. #### revid > **revid**: `number` New revision id created by the change. #### title > **title**: `string` Page title. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md --- > 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: ApiCheckTokenResponse Defined in: [core/checktoken.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/checktoken.ts#L19) Response of `action=checktoken`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### checktoken > **checktoken**: `object` Defined in: [core/checktoken.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/checktoken.ts#L21) Result of `action=checktoken`. #### generated? > `optional` **generated?**: `string` ISO-8601 timestamp when the submitted token was generated; present whenever the token embeds one (including old tokens). #### result > **result**: [`ApiCheckTokenResult`](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResult.md) Outcome of the token check. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResult.md --- > 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. # Type Alias: ApiCheckTokenResult > **ApiCheckTokenResult** = `"valid"` | `"expired"` | `"invalid"` Defined in: [core/checktoken.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/checktoken.ts#L16) Result values of [ApiCheckTokenResponse](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiClearHasMsgResponse.md --- > 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: ApiClearHasMsgResponse Defined in: [core/clearhasmsg.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clearhasmsg.ts#L13) Response of `action=clearhasmsg`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### clearhasmsg > **clearhasmsg**: `string` Defined in: [core/clearhasmsg.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clearhasmsg.ts#L15) Status string; `success` on 1.43 (older builds returned an empty string). *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiClientLogin.md --- > 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: ApiClientLogin Defined in: [core/clientlogin.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L20) The `clientlogin` object of an `action=clientlogin` response. ## Properties ### canpreservestate? > `optional` **canpreservestate?**: `boolean` Defined in: [core/clientlogin.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L56) Whether the current AuthManager state can be preserved across requests; `FAIL`/`RESTART` only. *** ### fields? > `optional` **fields?**: `Record`\<`string`, [`ApiQueryAuthManagerField`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerField.md)> Defined in: [core/clientlogin.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L53) Field descriptors merged across all `requests`, present only when the request passed `mergerequestfields`. *** ### message? > `optional` **message?**: [`ApiAuthManagerMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) Defined in: [core/clientlogin.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L32) Failure / interaction message, rendered per the `messageformat` parameter: a string under `wikitext`/`html`, a `{ key, params }` object under `raw`, absent under `none`. `FAIL`/`UI`/`RESTART` only. *** ### messagecode? > `optional` **messagecode?**: `string` Defined in: [core/clientlogin.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L35) Machine-readable message code accompanying `message`; `FAIL`/`UI`/`RESTART` only. *** ### redirectdata? > `optional` **redirectdata?**: `Record`\<`string`, `unknown`> Defined in: [core/clientlogin.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L44) Data for a `REDIRECT` response the client may use to query the remote site via its API instead of following `redirecttarget`. *** ### redirecttarget? > `optional` **redirecttarget?**: `string` Defined in: [core/clientlogin.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L38) URL to continue the flow at. `REDIRECT` only. *** ### requests? > `optional` **requests?**: [`ApiQueryAuthManagerInfoRequest`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md)\[] Defined in: [core/clientlogin.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L47) AuthManager request descriptors to continue the flow; `UI`/`RESTART`/`REDIRECT` only. *** ### status? > `optional` **status?**: `string` & `object` | `"PASS"` | `"FAIL"` | `"UI"` | `"REDIRECT"` | `"RESTART"` Defined in: [core/clientlogin.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L22) Login outcome. *** ### username? > `optional` **username?**: `string` Defined in: [core/clientlogin.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L25) Authenticated user name; `PASS` only. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiClientLoginResponse.md --- > 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: ApiClientLoginResponse Defined in: [core/clientlogin.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L60) Response of `action=clientlogin`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### clientlogin > **clientlogin**: [`ApiClientLogin`](https://types-mediawiki-response.pages.dev/api/core/ApiClientLogin.md) Defined in: [core/clientlogin.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/clientlogin.ts#L62) Result of `action=clientlogin`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCodexIcon.md --- > 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. # Type Alias: ApiCodexIcon > **ApiCodexIcon** = `string` | [`ApiCodexIconDefinition`](https://types-mediawiki-response.pages.dev/api/core/ApiCodexIconDefinition.md) Defined in: [core/query/codexicons.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L34) A Codex icon: raw SVG markup, or a directionality/language-aware definition. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCodexIconDefinition.md --- > 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: ApiCodexIconDefinition Defined in: [core/query/codexicons.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L13) Directionality/language-aware icon definition (object form of [ApiCodexIcon](https://types-mediawiki-response.pages.dev/api/core/ApiCodexIcon.md)). ## Properties ### default? > `optional` **default?**: `string` Defined in: [core/query/codexicons.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L15) SVG markup used when no direction-specific variant applies. *** ### langCodeMap? > `optional` **langCodeMap?**: `Record`\<`string`, `string`> Defined in: [core/query/codexicons.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L30) Language-specific SVG markup, keyed by language code. *** ### ltr? > `optional` **ltr?**: `string` Defined in: [core/query/codexicons.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L18) SVG markup for left-to-right contexts. *** ### rtl? > `optional` **rtl?**: `string` Defined in: [core/query/codexicons.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L21) SVG markup for right-to-left contexts. *** ### shouldFlip? > `optional` **shouldFlip?**: `boolean` Defined in: [core/query/codexicons.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L24) Whether the icon should be flipped in right-to-left contexts. *** ### shouldFlipExceptions? > `optional` **shouldFlipExceptions?**: `string`\[] Defined in: [core/query/codexicons.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L27) Languages excluded from flipping, e.g. `["he", "yi"]`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCompareResponse.md --- > 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: ApiCompareResponse Defined in: [core/compare.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L107) Response of `action=compare`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### compare > **compare**: [`ApiCompareResult`](https://types-mediawiki-response.pages.dev/api/core/ApiCompareResult.md) Defined in: [core/compare.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L109) Result of `action=compare`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCompareResult.md --- > 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: ApiCompareResult Defined in: [core/compare.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L15) The `compare` object of a successful `action=compare` response. ## Properties ### bodies? > `optional` **bodies?**: `Record`\<`string`, `string`> Defined in: [core/compare.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L23) Per-slot diff bodies, keyed by slot role. `prop=diff` when comparing specific slots (`fromslots`/`toslots`); takes the place of [body](#body). *** ### body? > `optional` **body?**: `string` Defined in: [core/compare.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L17) Diff HTML. `prop=diff`; only when the diff is not split per slot. *** ### diffsize? > `optional` **diffsize?**: `number` Defined in: [core/compare.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L26) Size of the diff HTML in bytes. `prop=diffsize`. *** ### fromarchive? > `optional` **fromarchive?**: `true` Defined in: [core/compare.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L67) The `from` revision was read from the archive (deleted since it was referenced). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### fromcomment? > `optional` **fromcomment?**: `string` Defined in: [core/compare.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L50) Edit summary of the `from` revision. `prop=comment`. *** ### fromcommenthidden? > `optional` **fromcommenthidden?**: `true` Defined in: [core/compare.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L61) The `from` revision's summary is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### fromid? > `optional` **fromid?**: `number` Defined in: [core/compare.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L34) Page id of the `from` side. `prop=ids`. *** ### fromns? > `optional` **fromns?**: `number` Defined in: [core/compare.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L38) Namespace index of the `from` side. `prop=title`. *** ### fromparsedcomment? > `optional` **fromparsedcomment?**: `string` Defined in: [core/compare.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L52) HTML-rendered summary of the `from` revision. `prop=comment` or `prop=parsedcomment`. *** ### fromrevid? > `optional` **fromrevid?**: `number` Defined in: [core/compare.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L36) Revision id of the `from` side. `prop=ids`. *** ### fromsize? > `optional` **fromsize?**: `number` Defined in: [core/compare.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L42) Revision size in bytes of the `from` side. `prop=size`. *** ### fromsuppressed? > `optional` **fromsuppressed?**: `true` Defined in: [core/compare.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L64) Suppression (oversight) applies to the `from` revision, alongside the `*hidden` flags. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### fromtexthidden? > `optional` **fromtexthidden?**: `true` Defined in: [core/compare.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L55) The `from` revision's content is hidden (revision-deleted). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### fromtimestamp? > `optional` **fromtimestamp?**: `string` Defined in: [core/compare.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L44) Timestamp of the `from` revision. `prop=timestamp`. *** ### fromtitle? > `optional` **fromtitle?**: `string` Defined in: [core/compare.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L40) Page title of the `from` side. `prop=title`. *** ### fromuser? > `optional` **fromuser?**: `string` Defined in: [core/compare.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L46) Editor of the `from` revision. `prop=user`. *** ### fromuserhidden? > `optional` **fromuserhidden?**: `true` Defined in: [core/compare.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L58) The `from` revision's author is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### fromuserid? > `optional` **fromuserid?**: `number` Defined in: [core/compare.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L48) Editor user id of the `from` revision. `prop=user`. *** ### next? > `optional` **next?**: `number` Defined in: [core/compare.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L31) Revision id following the `to` side. `prop=rel`. *** ### prev? > `optional` **prev?**: `number` Defined in: [core/compare.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L29) Revision id preceding the `from` side. `prop=rel`. *** ### toarchive? > `optional` **toarchive?**: `true` Defined in: [core/compare.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L103) The `to` revision was read from the archive (deleted since it was referenced). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### tocomment? > `optional` **tocomment?**: `string` Defined in: [core/compare.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L86) Edit summary of the `to` revision. `prop=comment`. *** ### tocommenthidden? > `optional` **tocommenthidden?**: `true` Defined in: [core/compare.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L97) The `to` revision's summary is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### toid? > `optional` **toid?**: `number` Defined in: [core/compare.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L70) Page id of the `to` side. `prop=ids`. *** ### tons? > `optional` **tons?**: `number` Defined in: [core/compare.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L74) Namespace index of the `to` side. `prop=title`. *** ### toparsedcomment? > `optional` **toparsedcomment?**: `string` Defined in: [core/compare.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L88) HTML-rendered summary of the `to` revision. `prop=comment` or `prop=parsedcomment`. *** ### torevid? > `optional` **torevid?**: `number` Defined in: [core/compare.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L72) Revision id of the `to` side. `prop=ids`. *** ### tosize? > `optional` **tosize?**: `number` Defined in: [core/compare.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L78) Revision size in bytes of the `to` side. `prop=size`. *** ### tosuppressed? > `optional` **tosuppressed?**: `true` Defined in: [core/compare.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L100) Suppression (oversight) applies to the `to` revision, alongside the `*hidden` flags. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### totexthidden? > `optional` **totexthidden?**: `true` Defined in: [core/compare.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L91) The `to` revision's content is hidden (revision-deleted). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### totimestamp? > `optional` **totimestamp?**: `string` Defined in: [core/compare.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L80) Timestamp of the `to` revision. `prop=timestamp`. *** ### totitle? > `optional` **totitle?**: `string` Defined in: [core/compare.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L76) Page title of the `to` side. `prop=title`. *** ### touser? > `optional` **touser?**: `string` Defined in: [core/compare.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L82) Editor of the `to` revision. `prop=user`. *** ### touserhidden? > `optional` **touserhidden?**: `true` Defined in: [core/compare.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L94) The `to` revision's author is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### touserid? > `optional` **touserid?**: `number` Defined in: [core/compare.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/compare.ts#L84) Editor user id of the `to` revision. `prop=user`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiContributor.md --- > 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: ApiContributor Defined in: [core/query/contributors.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L12) One contributor entry: a logged-in (registered or temporary) editor. ## Properties ### name > **name**: `string` Defined in: [core/query/contributors.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L17) Contributor name (IPs never appear as contributors). *** ### userid > **userid**: `number` Defined in: [core/query/contributors.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L14) User id of the contributor. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiCreateAccountResponse.md --- > 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: ApiCreateAccountResponse Defined in: [core/createaccount.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/createaccount.ts#L22) Response of `action=createaccount`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### createaccount > **createaccount**: `object` Defined in: [core/createaccount.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/createaccount.ts#L24) Result of `action=createaccount`. #### canpreservestate? > `optional` **canpreservestate?**: `boolean` Whether the current AuthManager state can be preserved across requests; `FAIL`/`RESTART` only. #### message? > `optional` **message?**: [`ApiAuthManagerMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) Failure / interaction message, rendered per the `messageformat` parameter: a string under `wikitext`/`html`, a `{ key, params }` object under `raw`, absent under `none`. `FAIL`/`UI`/`RESTART` only. #### messagecode? > `optional` **messagecode?**: `string` Machine-readable message code (e.g. `invaliduser`). #### redirectdata? > `optional` **redirectdata?**: `Record`\<`string`, `unknown`> Extra API data accompanying a `REDIRECT` outcome. #### redirecttarget? > `optional` **redirecttarget?**: `string` Redirect target for a `REDIRECT` outcome. #### requests? > `optional` **requests?**: [`ApiQueryAuthManagerInfoRequest`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md)\[] AuthManager request descriptors for interactive (`UI`/`RESTART`) and `REDIRECT` steps. #### status? > `optional` **status?**: [`ApiAuthManagerStatus`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerStatus.md) AuthManager outcome of the account-creation flow. #### username? > `optional` **username?**: `string` Created (or attempted) user name; present on `PASS`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiDbReplLag.md --- > 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: ApiDbReplLag Defined in: [core/query/siteinfo.ts:569](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L569) One database host (`siprop=dbrepllag`). ## Properties ### host > **host**: `string` Defined in: [core/query/siteinfo.ts:571](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L571) Host name; empty string when `$wgShowHostnames` hides it. *** ### lag > **lag**: `number` Defined in: [core/query/siteinfo.ts:574](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L574) Seconds of lag; `-1` when the host is not a replica. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResponse.md --- > 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: ApiDeleteResponse Defined in: [core/delete.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L33) Response of `action=delete`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### delete > **delete**: [`ApiDeleteResult`](https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResult.md) Defined in: [core/delete.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L35) Result of `action=delete`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResult.md --- > 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: ApiDeleteResult Defined in: [core/delete.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L14) The `delete` object of an `action=delete` response. ## Properties ### logid? > `optional` **logid?**: `number` Defined in: [core/delete.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L29) Log id of the new deletion log entry. *** ### reason > **reason**: `string` Defined in: [core/delete.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L19) Deletion reason (echoed back). *** ### scheduled? > `optional` **scheduled?**: `true` Defined in: [core/delete.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L26) The deletion was scheduled for asynchronous processing instead of running inline (large pages, above `$wgDeleteRevisionsBatchSize`). Mutually exclusive with [logid](#logid): a scheduled deletion has no log entry yet. *** ### title > **title**: `string` Defined in: [core/delete.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/delete.ts#L16) Deleted page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRev.md --- > 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: ApiDeletedRev Defined in: [core/query/deletedrevs.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L22) One archived revision, as `list=deletedrevs` formats it. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### comment? > `optional` **comment?**: `string` Defined in: [core/query/deletedrevs.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L39) Raw edit summary. `drprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### len? > `optional` **len?**: `string` Defined in: [core/query/deletedrevs.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L50) Revision size in bytes, **as a string** (`"19"`). `drprop=len`. *** ### minor? > `optional` **minor?**: `boolean` Defined in: [core/query/deletedrevs.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L45) Whether the edit was marked minor. `drprop=minor`; a real `boolean`. *** ### parentid? > `optional` **parentid?**: `number` Defined in: [core/query/deletedrevs.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L30) Parent revision id; `0` for a page's first revision. `drprop=parentid`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/deletedrevs.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L42) HTML-rendered edit summary. `drprop=parsedcomment`. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/deletedrevs.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L27) Revision id. `drprop=revid`. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/deletedrevs.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L53) Content checksum (hex), or `''` when unavailable. `drprop=sha1`. *** ### sha1hidden? > `optional` **sha1hidden?**: `true` Defined in: [core/query/deletedrevs.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L62) The checksum is withheld. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [core/query/deletedrevs.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L56) Change tags. `drprop=tags`; `[]` when none. *** ### texthidden? > `optional` **texthidden?**: `true` Defined in: [core/query/deletedrevs.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L59) The content is hidden, which also hides `sha1`. Revision-delete; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### timestamp > **timestamp**: `string` Defined in: [core/query/deletedrevs.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L24) Revision timestamp — returned unconditionally, not a `drprop` value. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/deletedrevs.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L33) Editor name. `drprop=user`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/deletedrevs.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L36) Editor user id. `drprop=userid`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRevs.md --- > 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: ApiDeletedRevs Defined in: [core/query/deletedrevs.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L66) One page group. `drprop=content` also yields the revision text. ## Properties ### ns > **ns**: `number` Defined in: [core/query/deletedrevs.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L68) Namespace index. *** ### revisions > **revisions**: [`ApiDeletedRev`](https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRev.md)\[] Defined in: [core/query/deletedrevs.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L74) The page's archived revisions. *** ### title > **title**: `string` Defined in: [core/query/deletedrevs.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L71) Full page title. *** ### ~~token?~~ > `optional` **token?**: `string` Defined in: [core/query/deletedrevs.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L84) Token for restoring the revisions; a CSRF token (the same value for every page), issued only to callers with the `undelete` right on same-origin requests. `drprop=token`. #### Deprecated since MediaWiki 1.24; request a CSRF token from `meta=tokens` instead. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiDuplicateFile.md --- > 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: ApiDuplicateFile Defined in: [core/query/duplicatefiles.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/duplicatefiles.ts#L15) One other file with the same content. ## Properties ### name > **name**: `string` Defined in: [core/query/duplicatefiles.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/duplicatefiles.ts#L17) File name with underscores, without the `File:` prefix. *** ### shared > **shared**: `boolean` Defined in: [core/query/duplicatefiles.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/duplicatefiles.ts#L23) Whether the file lives on a shared repo rather than this wiki. A real `boolean`. *** ### timestamp > **timestamp**: `string` Defined in: [core/query/duplicatefiles.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/duplicatefiles.ts#L20) When that file's current version was uploaded. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/duplicatefiles.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/duplicatefiles.ts#L26) Uploader of that file's current version. Absent when the uploader is hidden. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiEditCaptcha.md --- > 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: ApiEditCaptcha Defined in: [core/edit.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L89) The captcha challenge of a `result: "Failure"` edit, as emitted by ConfirmEdit. ## Properties ### id? > `optional` **id?**: `string` Defined in: [core/edit.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L97) Cache key of the pending challenge; pass it back as `captchaid` alongside the `captchaword` answer. *** ### mime? > `optional` **mime?**: `string` Defined in: [core/edit.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L94) MIME type the challenge renders as, e.g. `text/plain`, `image/png`, `text/html`. *** ### question? > `optional` **question?**: `string` Defined in: [core/edit.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L100) Challenge text: an arithmetic expression for the sample implementation, the prompt for a question captcha. *** ### type? > `optional` **type?**: `string` Defined in: [core/edit.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L91) Captcha implementation, e.g. `simple` (arithmetic challenge) or `image`. Open union. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md --- > 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: ApiEditResponse Defined in: [core/edit.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L104) Response of `action=edit`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### edit > **edit**: [`ApiEditResult`](https://types-mediawiki-response.pages.dev/api/core/ApiEditResult.md) Defined in: [core/edit.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L106) Result of `action=edit`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiEditResult.md --- > 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: ApiEditResult Defined in: [core/edit.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L21) The `edit` object of an `action=edit` response. ## Properties ### captcha? > `optional` **captcha?**: [`ApiEditCaptcha`](https://types-mediawiki-response.pages.dev/api/core/ApiEditCaptcha.md) Defined in: [core/edit.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L85) Captcha challenge returned when ConfirmEdit aborted the save. Present only in the in-band failure branch; [ApiEditCaptcha.id](https://types-mediawiki-response.pages.dev/api/core/ApiEditCaptcha.md#id) and [ApiEditCaptcha.question](https://types-mediawiki-response.pages.dev/api/core/ApiEditCaptcha.md#question) are per-request random values. *** ### code? > `optional` **code?**: `string` Defined in: [core/edit.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L75) Machine-readable failure code. *** ### contentmodel? > `optional` **contentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/edit.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L32) Content model of the page. *** ### info? > `optional` **info?**: `string` Defined in: [core/edit.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L78) Human-readable failure description. *** ### new? > `optional` **new?**: `true` Defined in: [core/edit.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L35) `true` when the edit created the page. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### newrevid? > `optional` **newrevid?**: `number` Defined in: [core/edit.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L53) Revision id created by the edit. *** ### newtimestamp? > `optional` **newtimestamp?**: `string` Defined in: [core/edit.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L56) Timestamp of the new revision. *** ### nochange? > `optional` **nochange?**: `true` Defined in: [core/edit.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L38) `true` when the supplied text equaled the current text. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### oldrevid? > `optional` **oldrevid?**: `number` Defined in: [core/edit.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L50) Revision id before the edit; `0` when the page was created. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/edit.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L26) Page id of the edited page. *** ### result > **result**: `string` & `object` | `"Success"` | `"Failure"` Defined in: [core/edit.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L23) Outcome of the request. Open union; the failure branch is documented below. *** ### tempusercreated? > `optional` **tempusercreated?**: `true` Defined in: [core/edit.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L64) `true` when the edit auto-created a temporary account for the (formerly anonymous) editor. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.41 *** ### tempusercreatedredirect? > `optional` **tempusercreatedredirect?**: `string` Defined in: [core/edit.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L72) Full URL to redirect to after a temporary-account auto-creation. Present only alongside [tempusercreated](#tempusercreated). #### Since MediaWiki 1.41 *** ### title? > `optional` **title?**: `string` Defined in: [core/edit.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L29) Normalized page title. *** ### watched? > `optional` **watched?**: `true` Defined in: [core/edit.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L41) `true` when the page was added to the user's watchlist. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### watchlistexpiry? > `optional` **watchlistexpiry?**: `string` Defined in: [core/edit.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/edit.ts#L47) When the watch applied by this edit expires. Only alongside [watched](#watched), and only when the watch carries an expiry. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiEmailUserResponse.md --- > 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: ApiEmailUserResponse Defined in: [core/emailuser.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/emailuser.ts#L19) Response of `action=emailuser`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### emailuser > **emailuser**: `object` Defined in: [core/emailuser.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/emailuser.ts#L21) Result of `action=emailuser`. #### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] In-band delivery errors (present when `result` is `Failure`), shaped per the request's `errorformat`. #### result > **result**: `string` & `object` | `"Success"` | `"Failure"` | `"Warnings"` Whether the message was accepted, or accepted with warnings, or failed. #### warnings? > `optional` **warnings?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Non-fatal messages (e.g. subject/text transformations), shaped per the request's `errorformat`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiEmbeddedIn.md --- > 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: ApiEmbeddedIn Defined in: [core/query/embeddedin.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/embeddedin.ts#L15) One page that embeds the target title. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/embeddedin.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/embeddedin.ts#L17) The embedding page is itself a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md --- > 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: ApiEnvelope Defined in: [envelope/index.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L171) Fields that may appear on every API response, successful or not. ## Extended by - [`ApiAbuseFilterCheckSyntaxResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckSyntaxResponse.md) - [`ApiAbuseFilterEvalExpressionResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterEvalExpressionResponse.md) - [`ApiAbuseFilterCheckMatchResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckMatchResponse.md) - [`ApiAbuseFilterUnblockAutopromoteResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterUnblockAutopromoteResponse.md) - [`ApiAbuseLogPrivateDetailsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogPrivateDetailsResponse.md) - [`ApiCategoryTreeResponse`](https://types-mediawiki-response.pages.dev/api/extensions/categorytree/ApiCategoryTreeResponse.md) - [`ApiGlobalUserRightsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResponse.md) - [`ApiSetGlobalAccountStatusResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResponse.md) - [`ApiSetGlobalAccountStatusFailedResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md) - [`ApiDeleteGlobalAccountResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResponse.md) - [`ApiCreateLocalAccountResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResponse.md) - [`ApiCentralAuthTokenResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthTokenResponse.md) - [`ApiCentralAuthInBandErrorResponse`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthInBandErrorResponse.md) - [`ApiDiscussionToolsPageInfoResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPageInfoResponse.md) - [`ApiDiscussionToolsFindCommentResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFindCommentResponse.md) - [`ApiDiscussionToolsGetSubscriptionsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsGetSubscriptionsResponse.md) - [`ApiDiscussionToolsSubscribeResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsSubscribeResponse.md) - [`ApiDiscussionToolsThankResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsThankResponse.md) - [`ApiDiscussionToolsCompareResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCompareResponse.md) - [`ApiDiscussionToolsPreviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPreviewResponse.md) - [`ApiDiscussionToolsEditResponse`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsEditResponse.md) - [`ApiEchoMuteResponse`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoMuteResponse.md) - [`ApiEchoCreateEventResponse`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoCreateEventResponse.md) - [`ApiEchoPushSubscriptionsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoPushSubscriptionsResponse.md) - [`ApiReviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiReviewResponse.md) - [`ApiStabilizeResponse`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiStabilizeResponse.md) - [`ApiFlagConfigResponse`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigResponse.md) - [`ApiGlobalBlockErrorResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockErrorResponse.md) - [`ApiGlobalBlockResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResponse.md) - [`ApiGlobalPreferencesResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResponse.md) - [`ApiGlobalPreferenceOverridesResponse`](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverridesResponse.md) - [`ApiEditMassMessageListResponse`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResponse.md) - [`ApiMassMessageResponse`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResponse.md) - [`ApiOATHValidateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidateResponse.md) - [`ApiWebAuthnResponse`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResponse.md) - [`ApiReadingListsSetupResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsSetupResponse.md) - [`ApiReadingListsCreateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateResponse.md) - [`ApiReadingListsUpdateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsUpdateResponse.md) - [`ApiReadingListsDeleteResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteResponse.md) - [`ApiReadingListsCreateEntryResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateEntryResponse.md) - [`ApiReadingListsDeleteEntryResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteEntryResponse.md) - [`ApiReadingListsTeardownResponse`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsTeardownResponse.md) - [`ApiSiteMatrixResponse`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResponse.md) - [`ApiSpamBlacklistResponse`](https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/ApiSpamBlacklistResponse.md) - [`ApiTemplateDataResponse`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataResponse.md) - [`ApiThankResponse`](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResponse.md) - [`ApiTranscodeResetResponse`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeResetResponse.md) - [`ApiTitleBlacklistResponse`](https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/ApiTitleBlacklistResponse.md) - [`ApiTranslationAidsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsResponse.md) - [`ApiTranslationStatsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStatsResponse.md) - [`ApiTtmServerResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerResponse.md) - [`ApiMarkForTranslationResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResponse.md) - [`ApiTranslationReviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationReviewResponse.md) - [`ApiGroupReviewResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiGroupReviewResponse.md) - [`ApiAggregateGroupsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResponse.md) - [`ApiTranslationEntitySearchResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResponse.md) - [`ApiTranslateSandboxCreateResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxCreateResponse.md) - [`ApiTranslateSandboxActionResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxActionResponse.md) - [`ApiTranslationStashResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStashResponse.md) - [`ApiMessageGroupSubscriptionResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupSubscriptionResponse.md) - [`ApiSearchTranslationsResponse`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsResponse.md) - [`ApiUlsSetLanguageResponse`](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsSetLanguageResponse.md) - [`ApiShortenUrlResponse`](https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResponse.md) - [`ApiVisualEditorResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorResponse.md) - [`ApiVisualEditorTemplatesUsedResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorTemplatesUsedResponse.md) - [`ApiVisualEditorParseFragmentResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorParseFragmentResponse.md) - [`ApiVisualEditorEditResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorEditResponse.md) - [`ApiEditCheckReferenceUrlResponse`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiEditCheckReferenceUrlResponse.md) - [`ApiWikiLoveResponse`](https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveResponse.md) - [`ApiBcErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiBcErrorResponse.md) - [`ApiModernErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiModernErrorResponse.md) - [`ApiQueryResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md) - [`ApiWatchlistRawResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawResponse.md) - [`ApiParseResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiParseResponse.md) - [`ApiParseOnlyPstResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiParseOnlyPstResponse.md) - [`ApiCompareResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiCompareResponse.md) - [`ApiEditResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiEditResponse.md) - [`ApiMoveResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveResponse.md) - [`ApiPurgeResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeResponse.md) - [`ApiDeleteResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiDeleteResponse.md) - [`ApiUndeleteResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResponse.md) - [`ApiBlockResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockResponse.md) - [`ApiUnblockResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResponse.md) - [`ApiWatchResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchResponse.md) - [`ApiRollbackResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResponse.md) - [`ApiPatrolResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResponse.md) - [`ApiOptionsResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiOptionsResponse.md) - [`ApiExpandTemplatesResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResponse.md) - [`ApiProtectResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiProtectResponse.md) - [`ApiRevisionDeleteResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResponse.md) - [`ApiCheckTokenResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiCheckTokenResponse.md) - [`ApiLanguageSearchResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageSearchResponse.md) - [`ApiAcquireTempUserNameResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiAcquireTempUserNameResponse.md) - [`ApiClearHasMsgResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiClearHasMsgResponse.md) - [`ApiValidatePasswordResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiValidatePasswordResponse.md) - [`ApiUserrightsResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUserrightsResponse.md) - [`ApiChangeContentModelResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiChangeContentModelResponse.md) - [`ApiSetPageLanguageResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiSetPageLanguageResponse.md) - [`ApiManageTagsResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsResponse.md) - [`ApiTagResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiTagResponse.md) - [`ApiMergeHistoryResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiMergeHistoryResponse.md) - [`ApiSetNotificationTimestampResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampResponse.md) - [`ApiEmailUserResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiEmailUserResponse.md) - [`ApiClientLoginResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiClientLoginResponse.md) - [`ApiResetPasswordResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiResetPasswordResponse.md) - [`ApiCreateAccountResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiCreateAccountResponse.md) - [`ApiChangeAuthenticationDataResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiChangeAuthenticationDataResponse.md) - [`ApiRemoveAuthenticationDataResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiRemoveAuthenticationDataResponse.md) - [`ApiLoginResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiLoginResponse.md) - [`ApiLogoutResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiLogoutResponse.md) - [`ApiFileRevertResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiFileRevertResponse.md) - [`ApiImageRotateResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateResponse.md) - [`ApiStashEditResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiStashEditResponse.md) - [`ApiUploadResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadResponse.md) - [`ApiImportResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiImportResponse.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiError.md --- > 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: ApiError Defined in: [envelope/index.ts:138](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L138) The `error` object under the default (`bc`) `errorformat`. ## Indexable > \[`key`: `string`]: `unknown` Structured data attached to the message by the emitting code, merged into this object as top-level keys. ## Properties ### code > **code**: `string` Defined in: [envelope/index.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L140) Machine-readable error code, e.g. `badtoken`. *** ### docref? > `optional` **docref?**: `string` Defined in: [envelope/index.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L146) Docs link plus deprecation notices; nested in `error` under the `bc` format. *** ### info > **info**: `string` Defined in: [envelope/index.ts:143](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L143) Human-readable description provided by the server. *** ### trace? > `optional` **trace?**: `string` Defined in: [envelope/index.ts:149](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L149) PHP backtrace, when `$wgShowExceptionDetails` is on (non-usage exceptions). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiErrorResponse.md --- > 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. # Type Alias: ApiErrorResponse > **ApiErrorResponse** = [`ApiBcErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiBcErrorResponse.md) | [`ApiModernErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiModernErrorResponse.md) Defined in: [envelope/index.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L221) An API response describing a failed request (either `errorformat` family). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesCategory.md --- > 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: ApiExpandTemplatesCategory Defined in: [core/expandtemplates.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L27) One category the output would add. ## Properties ### category > **category**: `string` Defined in: [core/expandtemplates.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L29) Category name. *** ### sortkey > **sortkey**: `string` Defined in: [core/expandtemplates.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L32) Sort key; empty string when the default sort key applies. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesProperties.md --- > 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: ApiExpandTemplatesProperties Defined in: [core/expandtemplates.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L15) Page settings surfaced by `prop=properties`. Open key set. ## Indexable > \[`key`: `string`]: `unknown` Other page properties set by parser functions or hooks. ## Properties ### defaultsort? > `optional` **defaultsort?**: `string` Defined in: [core/expandtemplates.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L17) Sort key set by `{{DEFAULTSORT}}`. *** ### displaytitle? > `optional` **displaytitle?**: `string` Defined in: [core/expandtemplates.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L20) Display title set by `{{DISPLAYTITLE}}`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResponse.md --- > 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: ApiExpandTemplatesResponse Defined in: [core/expandtemplates.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L72) Response of `action=expandtemplates`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### expandtemplates > **expandtemplates**: [`ApiExpandTemplatesResult`](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResult.md) Defined in: [core/expandtemplates.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L74) Result of `action=expandtemplates`. *** ### ~~parsetree?~~ > `optional` **parsetree?**: `string` Defined in: [core/expandtemplates.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L84) XML parse tree of the input wikitext, emitted at the root level (outside [expandtemplates](#expandtemplates)) by the legacy `generatexml` parameter; with `prop=parsetree` the same tree is reported inside [ApiExpandTemplatesResult.parsetree](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResult.md#parsetree) instead. #### Deprecated since MediaWiki 1.25 (`generatexml`); use `prop=parsetree`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesResult.md --- > 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: ApiExpandTemplatesResult Defined in: [core/expandtemplates.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L36) The `expandtemplates` object of a successful response. ## Properties ### categories? > `optional` **categories?**: [`ApiExpandTemplatesCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesCategory.md)\[] Defined in: [core/expandtemplates.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L53) Categories the output would add. `prop=categories`; absent when the output adds none. *** ### encodedjsconfigvars? > `optional` **encodedjsconfigvars?**: `string` Defined in: [core/expandtemplates.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L68) The JS config variables serialized as a JSON string. `prop=encodedjsconfigvars`. *** ### jsconfigvars? > `optional` **jsconfigvars?**: `unknown` Defined in: [core/expandtemplates.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L65) Parser-magic JS config variables. `prop=jsconfigvars`. *** ### modules? > `optional` **modules?**: `string`\[] Defined in: [core/expandtemplates.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L56) ResourceLoader modules the output depends on. `prop=modules`. *** ### modulescripts? > `optional` **modulescripts?**: `never`\[] Defined in: [core/expandtemplates.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L59) Always empty; deprecated. Emitted with `prop=modules`. *** ### modulestyles? > `optional` **modulestyles?**: `string`\[] Defined in: [core/expandtemplates.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L62) ResourceLoader module styles the output depends on. `prop=modules`. *** ### parsetree? > `optional` **parsetree?**: `string` Defined in: [core/expandtemplates.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L41) XML parse tree of the input wikitext. `prop=parsetree`. *** ### properties? > `optional` **properties?**: [`ApiExpandTemplatesProperties`](https://types-mediawiki-response.pages.dev/api/core/ApiExpandTemplatesProperties.md) Defined in: [core/expandtemplates.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L50) Page settings parsed from the output. `prop=properties`. *** ### ttl? > `optional` **ttl?**: `number` Defined in: [core/expandtemplates.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L47) Cache TTL in seconds; `prop=ttl`, present only when the frame carries one. *** ### volatile? > `optional` **volatile?**: `boolean` Defined in: [core/expandtemplates.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L44) Whether the result varies per-user / request. `prop=volatile`; a real `boolean`. *** ### wikitext? > `optional` **wikitext?**: `string` Defined in: [core/expandtemplates.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/expandtemplates.ts#L38) The expanded wikitext. `prop=wikitext`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataField.md --- > 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: ApiExtMetadataField Defined in: [core/query/imageinfo.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L43) One structured `extmetadata` field. ## Properties ### hidden? > `optional` **hidden?**: `string` Defined in: [core/query/imageinfo.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L55) Presentation hint; serialized as an empty string when set (fv2 quirk). *** ### source? > `optional` **source?**: `string` Defined in: [core/query/imageinfo.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L52) Where the value came from, e.g. `mediawiki-metadata`. *** ### value? > `optional` **value?**: `string` | `number` | [`ApiExtMetadataMultilangValue`](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataMultilangValue.md) Defined in: [core/query/imageinfo.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L49) Field value: a string for most fields, numeric for a few (e.g. the extension version), or the raw [ApiExtMetadataMultilangValue](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataMultilangValue.md) map when the request set `iiextmetadatamultilang=1`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataMultilangValue.md --- > 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: ApiExtMetadataMultilangValue Defined in: [core/query/imageinfo.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L34) A multilang metadata value (`iiextmetadatamultilang=1`): the map of language codes to values that the API otherwise collapses to the best-matching language. `x-default` holds the fallback translation. ## Indexable > \[`lang`: `string`]: `string` | `number` | `undefined` The value per language code (e.g. `en`, `de`, `x-default`). ## Properties ### \_type? > `optional` **\_type?**: `"lang"` Defined in: [core/query/imageinfo.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L36) Serialization marker of the multilang map. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExtUrlUsage.md --- > 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: ApiExtUrlUsage Defined in: [core/query/exturlusage.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/exturlusage.ts#L11) One page whose content links to the searched URL. ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [core/query/exturlusage.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/exturlusage.ts#L16) Namespace index. `euprop=title` (default). *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/exturlusage.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/exturlusage.ts#L13) Page id. `euprop=ids`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/exturlusage.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/exturlusage.ts#L19) Full page title. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/exturlusage.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/exturlusage.ts#L27) The matched URL, reconstructed from the `externallinks` row (domain index plus stored path), not verbatim page text. `euprop=url` (default); `euexpandurl=1` expands protocol-relative URLs to the canonical protocol (deprecated since MediaWiki 1.43). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiExternalLink.md --- > 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: ApiExternalLink Defined in: [core/query/extlinks.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/extlinks.ts#L9) One external link used by a page. ## Properties ### url > **url**: `string` Defined in: [core/query/extlinks.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/extlinks.ts#L11) Full external URL. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiFileArchiveEntry.md --- > 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: ApiFileArchiveEntry Defined in: [core/query/filearchive.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L20) One archived file. `faprop` selects the optional fields; `id`, `name`, `ns` and `title` are emitted regardless of `faprop`. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### archivename? > `optional` **archivename?**: `string` Defined in: [core/query/filearchive.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L37) Stored name of a superseded version. Only on an archived _old_ version — absent for the newest stored file, even with `faprop=archivename`. *** ### bitdepth? > `optional` **bitdepth?**: `string` Defined in: [core/query/filearchive.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L91) Colour depth in bits, as a string. `faprop=bitdepth`; same visibility gate as `mime`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### description? > `optional` **description?**: `string` Defined in: [core/query/filearchive.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L52) Raw upload description (the file page's text). `faprop=description`. *** ### filehidden? > `optional` **filehidden?**: `true` Defined in: [core/query/filearchive.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L100) The file itself is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### filemissing? > `optional` **filemissing?**: `true` Defined in: [core/query/filearchive.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L49) The file's stored content is missing. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### height? > `optional` **height?**: `string` Defined in: [core/query/filearchive.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L70) Pixel height, as a string. Emitted with either `faprop=size` or `faprop=dimensions`. *** ### id > **id**: `number` Defined in: [core/query/filearchive.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L22) `filearchive` row id. *** ### mediatype? > `optional` **mediatype?**: `string` Defined in: [core/query/filearchive.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L85) MediaWiki media bucket, e.g. `BITMAP`. `faprop=mediatype`. *** ### metadata? > `optional` **metadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] | `null` Defined in: [core/query/filearchive.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L97) Raw format metadata (EXIF / PNG chunks / …). `faprop=metadata`; `null` when the row carries none. *** ### mime? > `optional` **mime?**: `string` Defined in: [core/query/filearchive.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L82) MIME type, e.g. `image/png`. `faprop=mime`; requires the file content to be visible to the requester (revision-delete bitfield) and present. *** ### name > **name**: `string` Defined in: [core/query/filearchive.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L25) File name with underscores, without the `File:` prefix. *** ### ns > **ns**: `number` Defined in: [core/query/filearchive.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L28) Namespace the file page lived in (always the File namespace). *** ### pagecount? > `optional` **pagecount?**: `number` Defined in: [core/query/filearchive.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L67) Number of pages, for multi-page formats; absent for formats without pages. Emitted with either `faprop=size` or `faprop=dimensions`. *** ### parseddescription? > `optional` **parseddescription?**: `string` Defined in: [core/query/filearchive.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L55) HTML-rendered upload description. `faprop=parseddescription`. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/filearchive.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L76) Content checksum (hex). `faprop=sha1`. *** ### size? > `optional` **size?**: `string` Defined in: [core/query/filearchive.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L61) File size in bytes, as a string. Emitted with either `faprop=size` or `faprop=dimensions`. *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/filearchive.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L40) Upload timestamp. `faprop=timestamp`. *** ### title > **title**: `string` Defined in: [core/query/filearchive.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L31) Full file page title. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/filearchive.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L43) Uploader name. `faprop=user`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/filearchive.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L46) Uploader id. `faprop=user`. *** ### width? > `optional` **width?**: `string` Defined in: [core/query/filearchive.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L73) Pixel width, as a string. Emitted with either `faprop=size` or `faprop=dimensions`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiFileExtension.md --- > 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: ApiFileExtension Defined in: [core/query/siteinfo.ts:452](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L452) One uploadable file extension (`siprop=fileextensions`). ## Properties ### ext > **ext**: `string` Defined in: [core/query/siteinfo.ts:454](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L454) Extension without the dot, e.g. `png`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiFileRepoInfo.md --- > 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: ApiFileRepoInfo Defined in: [core/query/filerepoinfo.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L15) One file repository: an element of the `query.repos` array. ## Properties ### apiurl? > `optional` **apiurl?**: `string` Defined in: [core/query/filerepoinfo.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L47) Base path of the repo wiki's API, for `ForeignAPIRepo` backends. `friprop=apiurl`. *** ### articleUrl? > `optional` **articleUrl?**: `string` Defined in: [core/query/filerepoinfo.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L53) URL prefix of the repo wiki's article pages. `friprop=articleUrl`. *** ### canUpload? > `optional` **canUpload?**: `boolean` Defined in: [core/query/filerepoinfo.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L44) Whether the requesting user may upload here. `friprop=canUpload`. *** ### descBaseUrl? > `optional` **descBaseUrl?**: `string` Defined in: [core/query/filerepoinfo.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L50) URL prefix of the repo wiki's file description pages (e.g. `…/wiki/File:`). `friprop=descBaseUrl`. *** ### descriptionCacheExpiry? > `optional` **descriptionCacheExpiry?**: `number` Defined in: [core/query/filerepoinfo.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L59) How long fetched descriptions are cached, in seconds. `friprop=descriptionCacheExpiry`. *** ### displayname? > `optional` **displayname?**: `string` Defined in: [core/query/filerepoinfo.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L20) Human-readable repo name. `friprop=displayname`. *** ### favicon? > `optional` **favicon?**: `string` Defined in: [core/query/filerepoinfo.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L38) URL of the repo wiki's favicon. `friprop=favicon`. *** ### fetchDescription? > `optional` **fetchDescription?**: `boolean` Defined in: [core/query/filerepoinfo.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L56) Whether description pages are fetched from the remote wiki. `friprop=fetchDescription`. *** ### initialCapital? > `optional` **initialCapital?**: `boolean` Defined in: [core/query/filerepoinfo.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L41) Whether titles on the repo wiki are capitalized on first letter. `friprop=initialCapital`. *** ### local? > `optional` **local?**: `boolean` Defined in: [core/query/filerepoinfo.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L23) Whether this is the wiki's own repo. `friprop=local`. *** ### name? > `optional` **name?**: `string` Defined in: [core/query/filerepoinfo.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L17) Repo id; `local` is the wiki's own repo. `friprop=name` (default). *** ### rootUrl? > `optional` **rootUrl?**: `string` Defined in: [core/query/filerepoinfo.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L29) Repo root without the hashed subpath. `friprop=rootUrl`. *** ### scriptDirUrl? > `optional` **scriptDirUrl?**: `string` Defined in: [core/query/filerepoinfo.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L35) Base path of the repo's wiki, e.g. `https://www.mediawiki.org/w`. `friprop=scriptDirUrl`. *** ### thumbUrl? > `optional` **thumbUrl?**: `string` Defined in: [core/query/filerepoinfo.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L32) Base path for thumbnails. `friprop=thumbUrl`. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/filerepoinfo.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L26) Public base path of the repo. `friprop=url`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiFileRevertResponse.md --- > 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: ApiFileRevertResponse Defined in: [core/filerevert.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/filerevert.ts#L14) Response of `action=filerevert`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### filerevert > **filerevert**: `object` Defined in: [core/filerevert.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/filerevert.ts#L16) Result of `action=filerevert`. #### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] In-band messages when the revert did not apply, shaped per the request's `errorformat`. #### result > **result**: `string` & `object` | `"Success"` | `"Failure"` Outcome of the revert. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiFileUsage.md --- > 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: ApiFileUsage Defined in: [core/query/fileusage.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/fileusage.ts#L12) One local usage record. `fuprop` controls which fields appear. ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [core/query/fileusage.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/fileusage.ts#L17) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/fileusage.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/fileusage.ts#L14) Page id of the using page. `fuprop=pageid`. *** ### redirect? > `optional` **redirect?**: `boolean` Defined in: [core/query/fileusage.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/fileusage.ts#L23) Whether the using page is a redirect. `fuprop=redirect`; a real `boolean`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/fileusage.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/fileusage.ts#L20) Full title of the using page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiGalleryOptions.md --- > 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: ApiGalleryOptions Defined in: [core/query/siteinfo.ts:319](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L319) `general.galleryoptions`: the site's `$wgGalleryOptions`, with core's defaults filled in for any key the site omits. ## Properties ### captionLength > **captionLength**: `boolean` Defined in: [core/query/siteinfo.ts:330](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L330) Whether captions are length-limited. A real `boolean`. *** ### imageHeight > **imageHeight**: `number` Defined in: [core/query/siteinfo.ts:327](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L327) Thumbnail height in pixels. *** ### imagesPerRow > **imagesPerRow**: `number` Defined in: [core/query/siteinfo.ts:321](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L321) Images per row; `0` lets the skin decide. *** ### imageWidth > **imageWidth**: `number` Defined in: [core/query/siteinfo.ts:324](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L324) Thumbnail width in pixels. *** ### mode > **mode**: `string` Defined in: [core/query/siteinfo.ts:339](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L339) Gallery layout, e.g. `traditional`, `nolines`, `packed`, `modified-packed`. *** ### showBytes > **showBytes**: `boolean` Defined in: [core/query/siteinfo.ts:333](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L333) Whether file sizes are shown. A real `boolean`. *** ### showDimensions > **showDimensions**: `boolean` Defined in: [core/query/siteinfo.ts:336](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L336) Whether dimensions are shown. A real `boolean`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md --- > 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: ApiHiddenFlags Defined in: [core/query/shared.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L23) Suppression ("RevisionDelete") visibility flags shared by the modules that report hidden users, comments and whole entries; each appears as a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) when that part of the record is hidden. ## Extended by - [`ApiRevision`](https://types-mediawiki-response.pages.dev/api/core/ApiRevision.md) - [`ApiUserContrib`](https://types-mediawiki-response.pages.dev/api/core/ApiUserContrib.md) - [`ApiRecentChange`](https://types-mediawiki-response.pages.dev/api/core/ApiRecentChange.md) - [`ApiLogEvent`](https://types-mediawiki-response.pages.dev/api/core/ApiLogEvent.md) - [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md) - [`ApiWatchlistEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistEntry.md) - [`ApiDeletedRev`](https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRev.md) - [`ApiFileArchiveEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiFileArchiveEntry.md) ## Properties ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md --- > 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: ApiImageInfo Defined in: [core/query/imageinfo.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L78) One image-info entry for a file page. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Extended by - [`ApiVideoInfo`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoInfo.md) - [`ApiAllImage`](https://types-mediawiki-response.pages.dev/api/core/ApiAllImage.md) ## Properties ### anon? > `optional` **anon?**: `true` Defined in: [core/query/imageinfo.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L237) Made by an anonymous (IP) uploader. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### archivename? > `optional` **archivename?**: `string` Defined in: [core/query/imageinfo.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L231) Archive name for a historical version. `iiprop=archivename`. *** ### bitdepth? > `optional` **bitdepth?**: `number` Defined in: [core/query/imageinfo.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L174) Color bit depth; `0` for files without dimensions (e.g. audio). `iiprop=bitdepth`. *** ### canonicaltitle? > `optional` **canonicaltitle?**: `string` Defined in: [core/query/imageinfo.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L110) Canonical localized file title. `iiprop=canonicaltitle`. *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/imageinfo.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L89) Raw upload comment. `iiprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### commonmetadata? > `optional` **commonmetadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] Defined in: [core/query/imageinfo.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L186) Metadata keys common to all file types, same item shape as [metadata](#metadata). `iiprop=commonmetadata`; an empty PHP map, so `[]` when there is none. *** ### descriptionshorturl? > `optional` **descriptionshorturl?**: `string` Defined in: [core/query/imageinfo.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L119) Shortened description-page URL. `iiprop=url`. *** ### descriptionurl? > `optional` **descriptionurl?**: `string` Defined in: [core/query/imageinfo.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L116) URL of the file description page. `iiprop=url`. *** ### duration? > `optional` **duration?**: `number` Defined in: [core/query/imageinfo.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L221) Media duration in seconds (audio/video), when the handler reports one. Emitted under `iiprop=size|dimensions`; there is no `iiprop=duration`. *** ### extmetadata? > `optional` **extmetadata?**: `Record`\<`string`, [`ApiExtMetadataField`](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataField.md)> Defined in: [core/query/imageinfo.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L194) Structured/extended metadata keyed by field name. `iiprop=extmetadata`. A bare MediaWiki core only produces `DateTime` and `ObjectName` here; the richer per-file fields (GPS, licensing, …) are contributed by `GetExtendedMetadata` hooks on the serving wiki (e.g. Extension:Metadata). *** ### filehidden? > `optional` **filehidden?**: `true` Defined in: [core/query/imageinfo.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L234) The file itself is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### filemissing? > `optional` **filemissing?**: `true` Defined in: [core/query/imageinfo.ts:215](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L215) `true` when the file itself does not exist on this wiki (a stub row). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### height? > `optional` **height?**: `number` Defined in: [core/query/imageinfo.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L107) Height in pixels; `0` for files without dimensions (e.g. audio). `iiprop=size|dimensions`. *** ### html? > `optional` **html?**: `string` Defined in: [core/query/imageinfo.ts:212](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L212) Upload-warning HTML ("a file with this name exists already…"). `iiprop=uploadwarning`; `""` when there is nothing to warn about. *** ### mediatype? > `optional` **mediatype?**: `string` Defined in: [core/query/imageinfo.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L171) Media type, e.g. `BITMAP`, `OFFICE`, `ARCHIVE`. `iiprop=mediatype`. *** ### metadata? > `optional` **metadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] | `null` Defined in: [core/query/imageinfo.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L180) Raw format metadata (EXIF / PNG chunks / …). `iiprop=metadata`; an explicit `null` when the file has no metadata at all. *** ### mime? > `optional` **mime?**: `string` Defined in: [core/query/imageinfo.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L168) MIME type, e.g. `image/png`. `iiprop=mime`. *** ### pagecount? > `optional` **pagecount?**: `number` Defined in: [core/query/imageinfo.ts:228](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L228) Page count (multi-page documents such as PDFs/TIFFs), when the handler supports one. Emitted under `iiprop=size|dimensions`; there is no `iiprop=pagecount`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/imageinfo.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L92) HTML-rendered comment. `iiprop=parsedcomment`. *** ### responsiveUrls? > `optional` **responsiveUrls?**: `Record`\<`string`, `string`> Defined in: [core/query/imageinfo.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L162) HiDPI (`2x`, …) source URLs keyed by pixel-density multiplier. Requires `iiprop=url`, plus a successful transform. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/imageinfo.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L165) File SHA-1 (hex). `iiprop=sha1`. *** ### size? > `optional` **size?**: `number` Defined in: [core/query/imageinfo.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L95) File size in bytes. `iiprop=size|dimensions`. *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/imageinfo.ts:244](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L244) The uploader is a temporary account. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 *** ### thumbattribs? > `optional` **thumbattribs?**: `Record`\<`string`, `string` | `number`> Defined in: [core/query/imageinfo.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L146) Pre-rendered `` attributes for the thumbnail (e.g. `src`, `width`, `srcset`). #### Since MediaWiki 1.47 *** ### thumberror? > `optional` **thumberror?**: `string` Defined in: [core/query/imageinfo.ts:206](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L206) Rendered text of the thumbnail error, when the thumbnail could not be made. Requires `iiprop=url`, plus a transform. *** ### thumbheight? > `optional` **thumbheight?**: `number` Defined in: [core/query/imageinfo.ts:138](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L138) Scaled thumbnail height (px). Falls back to the file's own height like [thumbwidth](#thumbwidth). *** ### thumbmime? > `optional` **thumbmime?**: `string` Defined in: [core/query/imageinfo.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L200) MIME type the thumbnail will be rendered as. `iiprop=thumbmime`, which requires `iiprop=url` and a transform via `iiurlwidth`/`iiurlheight`. *** ### thumburl? > `optional` **thumburl?**: `string` Defined in: [core/query/imageinfo.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L125) Scaled thumbnail URL. Requires `iiprop=url`, plus a transform requested via `iiurlwidth`, `iiurlheight` or `iiurlparam`. *** ### thumburls? > `optional` **thumburls?**: `Record`\<`string`, [`ApiThumbUrlEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiThumbUrlEntry.md)> Defined in: [core/query/imageinfo.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L156) Scaled thumbnail URLs at multiple widths, keyed by the produced thumbnail's width (normally the requested width; e.g. `"400"`, `"800"`). `iiprop=thumburls`. Each entry also folds in the transform's HTML `` attributes. #### Since MediaWiki 1.47 *** ### thumbwidth? > `optional` **thumbwidth?**: `number` Defined in: [core/query/imageinfo.ts:132](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L132) Scaled thumbnail width (px). Falls back to the file's own width when the thumbnail URL equals the original URL (no resize happened). Same requirements as [thumburl](#thumburl). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/imageinfo.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L80) Timestamp of the file's upload/reversion. `iiprop=timestamp`. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/imageinfo.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L113) Direct URL to the file. `iiprop=url`. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/imageinfo.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L83) Uploader user name. `iiprop=user`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/imageinfo.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L86) Uploader user id. `iiprop=userid`. *** ### width? > `optional` **width?**: `number` Defined in: [core/query/imageinfo.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L101) Width in pixels; `0` for files without dimensions (e.g. audio). `iiprop=size|dimensions`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImageLimit.md --- > 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: ApiImageLimit Defined in: [core/query/siteinfo.ts:343](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L343) One entry of `general.imagelimits`: a selectable display size. ## Properties ### height > **height**: `number` Defined in: [core/query/siteinfo.ts:348](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L348) Height in pixels. *** ### width > **width**: `number` Defined in: [core/query/siteinfo.ts:345](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L345) Width in pixels. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md --- > 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: ApiImageMetadataItem Defined in: [core/query/imageinfo.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L13) One entry in a file's raw format `metadata` array (may nest further items). ## Properties ### name? > `optional` **name?**: `string` | `number` Defined in: [core/query/imageinfo.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L18) Metadata field name, e.g. `width`, `XResolution`; positional entries of list-shaped fields (e.g. `ComponentsConfiguration`) use numeric names. *** ### value? > `optional` **value?**: `string` | `number` | `boolean` | `ApiImageMetadataItem`\[] Defined in: [core/query/imageinfo.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L26) Field value; a scalar (booleans occur, e.g. through `META_BC_BOOLS` serialization; EXIF RATIONALs serialize as `"num/den"` strings, GPS coordinates arrive as numbers) or a nested list of ApiImageMetadataItem. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateEntry.md --- > 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: ApiImageRotateEntry Defined in: [core/imagerotate.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L22) One file entry of an `action=imagerotate` response. ## Extends - [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md) ## Properties ### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/imagerotate.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L36) In-band messages when the rotation failed, shaped per the request's `errorformat`. *** ### id? > `optional` **id?**: `number` Defined in: [core/imagerotate.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L24) Page id of the file (keyed as `id`, not `pageid`). *** ### invalid? > `optional` **invalid?**: `true` Defined in: [core/query/index.ts:384](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L384) `true` when the supplied title is not a valid title. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`invalid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#invalid) *** ### invalidreason? > `optional` **invalidreason?**: `string` | [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) Defined in: [core/query/index.ts:390](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L390) Why the title is `invalid`: a plain string under the default (`bc`) `errorformat`, an [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`invalidreason`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#invalidreason) *** ### iw? > `optional` **iw?**: `string` Defined in: [core/imagerotate.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L30) Interwiki prefix, for entries describing an interwiki title. *** ### known? > `optional` **known?**: `true` Defined in: [core/query/index.ts:381](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L381) `true` when the page does not exist but its content is known (e.g. a defined but unsaved interface message). Emitted by the framework itself, without requesting `prop=info`. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`known`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#known) *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/index.ts:374](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L374) `true` when the page does not exist. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`missing`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#missing) *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/index.ts:368](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L368) Namespace index. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#ns) *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/index.ts:365](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L365) Page id. Absent when the id is unknown: a missing page requested by page id keeps its `pageid` alongside `missing`, while title-supplied missing/invalid pages and special pages carry no `pageid`. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#pageid) *** ### result? > `optional` **result?**: `string` & `object` | `"Success"` | `"Failure"` Defined in: [core/imagerotate.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L33) Per-file outcome. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/imagerotate.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L27) Revision id, for entries describing a `revid=` that did not resolve. *** ### special? > `optional` **special?**: `true` Defined in: [core/query/index.ts:393](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L393) `true` for pages in a special namespace. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`special`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#special) *** ### title? > `optional` **title?**: `string` Defined in: [core/query/index.ts:371](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L371) Full, normalized page title. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateResponse.md --- > 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: ApiImageRotateResponse Defined in: [core/imagerotate.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L40) Response of `action=imagerotate`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### imagerotate > **imagerotate**: [`ApiImageRotateEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateEntry.md)\[] Defined in: [core/imagerotate.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/imagerotate.ts#L42) Result of `action=imagerotate`; one entry per rotated image. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImageUsage.md --- > 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: ApiImageUsage Defined in: [core/query/imageusage.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageusage.ts#L18) One page that uses the target file. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/imageusage.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageusage.ts#L20) The using page is itself a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### redirlinks? > `optional` **redirlinks?**: `ApiImageUsage`\[] Defined in: [core/query/imageusage.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageusage.ts#L26) Pages that use the file through this redirect. Only on a `redirect` entry, and only with `iuredirect=1`. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImportEntry.md --- > 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: ApiImportEntry Defined in: [core/import.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L16) One imported page reported by `action=import`. ## Properties ### invalid? > `optional` **invalid?**: `true` Defined in: [core/import.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L27) The title was invalid or non-importable. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### ns? > `optional` **ns?**: `number` Defined in: [core/import.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L18) Target namespace the page was imported into. *** ### revisions? > `optional` **revisions?**: `number` Defined in: [core/import.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L24) Number of revisions successfully imported. *** ### title? > `optional` **title?**: `string` Defined in: [core/import.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L21) Imported page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiImportResponse.md --- > 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: ApiImportResponse Defined in: [core/import.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L31) Response of `action=import`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### import > **import**: [`ApiImportEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiImportEntry.md)\[] Defined in: [core/import.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/import.ts#L33) Result of `action=import`; one entry per imported page. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiInterwikiLink.md --- > 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: ApiInterwikiLink Defined in: [core/query/iwlinks.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwlinks.ts#L9) One interwiki link. ## Properties ### prefix > **prefix**: `string` Defined in: [core/query/iwlinks.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwlinks.ts#L11) Interwiki prefix, e.g. `en` / `m`. *** ### title > **title**: `string` Defined in: [core/query/iwlinks.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwlinks.ts#L14) Target title. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/iwlinks.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwlinks.ts#L17) Resolved target URL. `iwprop=url`, or the deprecated boolean `iwurl` parameter. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiInterwikiMapEntry.md --- > 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: ApiInterwikiMapEntry Defined in: [core/query/siteinfo.ts:578](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L578) One interwiki prefix (`siprop=interwikimap`). ## Properties ### api? > `optional` **api?**: `string` Defined in: [core/query/siteinfo.ts:626](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L626) API endpoint from the `interwiki` table. *** ### bcp47? > `optional` **bcp47?**: `string` Defined in: [core/query/siteinfo.ts:605](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L605) BCP 47 form of the language code. *** ### code? > `optional` **code?**: `string` Defined in: [core/query/siteinfo.ts:614](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L614) Effective language code of an `extralanglink` prefix. *** ### deprecated? > `optional` **deprecated?**: `string` Defined in: [core/query/siteinfo.ts:602](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L602) Current code when [prefix](#prefix) is a deprecated language code. #### Since MediaWiki 1.40 *** ### extralanglink? > `optional` **extralanglink?**: `true` Defined in: [core/query/siteinfo.ts:611](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L611) Present when the prefix feeds interlanguage links. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### language? > `optional` **language?**: `string` Defined in: [core/query/siteinfo.ts:595](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L595) Language name, for language-coded prefixes. *** ### linktext? > `optional` **linktext?**: `string` Defined in: [core/query/siteinfo.ts:617](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L617) Link text from `interlanguage-link-`. *** ### local? > `optional` **local?**: `true` Defined in: [core/query/siteinfo.ts:583](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L583) `true` when links using this prefix are always local (`iw_local`). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### localinterwiki? > `optional` **localinterwiki?**: `true` Defined in: [core/query/siteinfo.ts:608](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L608) Present for a locally defined prefix (`$wgLocalInterwikis`). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### prefix > **prefix**: `string` Defined in: [core/query/siteinfo.ts:580](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L580) Interwiki prefix, e.g. `mw`. *** ### protorel > **protorel**: `boolean` Defined in: [core/query/siteinfo.ts:592](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L592) Whether the stored template is protocol-relative. A real `boolean`. *** ### sitename? > `optional` **sitename?**: `string` Defined in: [core/query/siteinfo.ts:620](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L620) Site name from `interlanguage-link-sitename-`. *** ### trans? > `optional` **trans?**: `true` Defined in: [core/query/siteinfo.ts:586](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L586) `true` when the prefix may be transcluded (`iw_trans`). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### url > **url**: `string` Defined in: [core/query/siteinfo.ts:589](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L589) URL template, with `$1` for the target title. *** ### wikiid? > `optional` **wikiid?**: `string` Defined in: [core/query/siteinfo.ts:623](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L623) Wiki id, for `wikiid`-scoped prefixes. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiIwbacklink.md --- > 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: ApiIwbacklink Defined in: [core/query/iwbacklinks.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwbacklinks.ts#L11) One page carrying the searched interwiki link. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### iwprefix? > `optional` **iwprefix?**: `string` Defined in: [core/query/iwbacklinks.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwbacklinks.ts#L16) Interwiki prefix of the matched link, e.g. `q`. `iwblprop=iwprefix`. *** ### iwtitle? > `optional` **iwtitle?**: `string` Defined in: [core/query/iwbacklinks.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwbacklinks.ts#L19) Target title on the remote wiki. `iwblprop=iwtitle`. *** ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/iwbacklinks.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwbacklinks.ts#L13) `true` when the linking page is a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLangLink.md --- > 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: ApiLangLink Defined in: [core/query/langlinks.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L12) One interlanguage link. ## Properties ### autonym? > `optional` **autonym?**: `string` Defined in: [core/query/langlinks.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L29) Language name in its own language. `llprop=autonym`. *** ### lang > **lang**: `string` Defined in: [core/query/langlinks.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L14) Target language code, e.g. `de`. *** ### langname? > `optional` **langname?**: `string` Defined in: [core/query/langlinks.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L26) Language name, localized to `inlanguagecode`, which defaults to the site's content language (not the requesting user's UI language). `llprop=langname`. *** ### title > **title**: `string` Defined in: [core/query/langlinks.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L17) Title of the linked page on the target wiki. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/langlinks.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L20) Full URL of the linked page. `llprop=url`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLangbacklink.md --- > 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: ApiLangbacklink Defined in: [core/query/langbacklinks.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langbacklinks.ts#L11) One page carrying the searched language link. ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### lllang? > `optional` **lllang?**: `string` Defined in: [core/query/langbacklinks.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langbacklinks.ts#L16) Language code of the matched link, e.g. `de`. `lblprop=lllang`. *** ### lltitle? > `optional` **lltitle?**: `string` Defined in: [core/query/langbacklinks.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langbacklinks.ts#L19) Target title on the other language's wiki. `lblprop=lltitle`. *** ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/langbacklinks.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langbacklinks.ts#L13) `true` when the linking page is a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLanguageInfo.md --- > 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: ApiLanguageInfo Defined in: [core/query/languageinfo.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L10) Information about one language (`meta=languageinfo`, keyed by code). ## Properties ### autonym? > `optional` **autonym?**: `string` Defined in: [core/query/languageinfo.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L21) Name in the language itself. `liprop=autonym`. *** ### bcp47? > `optional` **bcp47?**: `string` Defined in: [core/query/languageinfo.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L15) BCP 47 language tag. `liprop=bcp47`. *** ### code? > `optional` **code?**: `string` Defined in: [core/query/languageinfo.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L12) Language code. `liprop=code`. *** ### digitgroupingpattern? > `optional` **digitgroupingpattern?**: `string` Defined in: [core/query/languageinfo.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L53) CLDR digit-grouping pattern (e.g. `#,##0.###`). `liprop=digitgroupingpattern`. #### Since MediaWiki 1.47 *** ### digittransforms? > `optional` **digittransforms?**: `string`\[] | `Record`\<`string`, `string`> Defined in: [core/query/languageinfo.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L46) Digit transforms: an ASCII-digit → localized-digit mapping. `liprop=digittransforms`. A PHP map keyed `0..9`; when a language omits some entries it serializes as an object, and an empty table surfaces as `[]`. #### Since MediaWiki 1.47 *** ### dir? > `optional` **dir?**: `"ltr"` | `"rtl"` Defined in: [core/query/languageinfo.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L18) Writing direction. `liprop=dir`. *** ### fallbacks? > `optional` **fallbacks?**: `string`\[] Defined in: [core/query/languageinfo.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L27) Fallback language codes, in order. `liprop=fallbacks`. *** ### minimumgroupingdigits? > `optional` **minimumgroupingdigits?**: `number` Defined in: [core/query/languageinfo.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L60) Minimum number of digits required before grouping applies. `liprop=minimumgroupingdigits`. #### Since MediaWiki 1.47 *** ### name? > `optional` **name?**: `string` Defined in: [core/query/languageinfo.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L24) Name in the content/`uselang` language. `liprop=name`. *** ### namespacealiases? > `optional` **namespacealiases?**: `Record`\<`string`, `number`> Defined in: [core/query/languageinfo.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L76) Localized namespace aliases, mapping each alias to its namespace id. `liprop=namespacealiases`. #### Since MediaWiki 1.47 *** ### namespacenames? > `optional` **namespacenames?**: `Record`\<`string`, `string`> Defined in: [core/query/languageinfo.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L68) Localized namespace names, keyed by numeric namespace id. `liprop=namespacenames`; the main namespace's value is the empty string. #### Since MediaWiki 1.47 *** ### variantnames? > `optional` **variantnames?**: `Record`\<`string`, `string`> Defined in: [core/query/languageinfo.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L37) Variant display names, keyed by variant code. `liprop=variantnames`. #### Since MediaWiki 1.40 *** ### variants? > `optional` **variants?**: `string`\[] Defined in: [core/query/languageinfo.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L30) Language-variant codes. `liprop=variants`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLanguageSearchResponse.md --- > 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: ApiLanguageSearchResponse Defined in: [core/languagesearch.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/languagesearch.ts#L16) Response of `action=languagesearch`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### languagesearch? > `optional` **languagesearch?**: `unknown`\[] | `Record`\<`string`, `string`> Defined in: [core/languagesearch.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/languagesearch.ts#L24) Matched languages keyed by language code, with the display name as the value (e.g. `"zh": "zh – chinese"`). Exact code matches come first; the remaining order is deterministic (grouped by the script of the first character, prefix matches before infix). A PHP map, so an empty result serializes as `[]`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLanguageVariant.md --- > 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: ApiLanguageVariant Defined in: [core/query/siteinfo.ts:642](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L642) One language variant and its fallbacks (`siprop=languagevariants`). ## Properties ### fallbacks? > `optional` **fallbacks?**: `string`\[] Defined in: [core/query/siteinfo.ts:644](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L644) Variant codes tried before falling back to the base language. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLinksHere.md --- > 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: ApiLinksHere Defined in: [core/query/linkshere.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/linkshere.ts#L11) One page in a `linkshere` result. `lhprop` controls which fields appear. ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [core/query/linkshere.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/linkshere.ts#L16) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/linkshere.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/linkshere.ts#L13) Page id. `lhprop=pageid`. *** ### redirect? > `optional` **redirect?**: `boolean` Defined in: [core/query/linkshere.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/linkshere.ts#L22) Whether the linking page is a redirect. `lhprop=redirect`; a real `boolean`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/linkshere.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/linkshere.ts#L19) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogBlockRestrictions.md --- > 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: ApiLogBlockRestrictions Defined in: [core/query/logparams.ts:341](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L341) Scope of a partial block (`restrictions`). ## Properties ### actions? > `optional` **actions?**: `string`\[] Defined in: [core/query/logparams.ts:349](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L349) Action names the block is restricted to (e.g. `'edit'`). *** ### namespaces? > `optional` **namespaces?**: `number`\[] Defined in: [core/query/logparams.ts:346](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L346) Namespace indexes the block is restricted to. *** ### pages? > `optional` **pages?**: [`ApiLogPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiLogPageRef.md)\[] Defined in: [core/query/logparams.ts:343](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L343) Pages the block is restricted to. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogEvent.md --- > 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: ApiLogEvent Defined in: [core/query/logevents.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L15) One log event. `leprop` controls which fields appear. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### action? > `optional` **action?**: `string` Defined in: [core/query/logevents.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L42) Log action, e.g. `create`, `delete`. `leprop=type`. *** ### actionhidden? > `optional` **actionhidden?**: `true` Defined in: [core/query/logevents.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L84) The log action/target is hidden (log-deleted). `leprop=ids|title`, or `leprop=details` on rows that have stored params. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### anon? > `optional` **anon?**: `true` Defined in: [core/query/logevents.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L71) Made by an anonymous (IP) actor. `leprop=user|userid`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/logevents.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L60) Raw log comment. `leprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### logid? > `optional` **logid?**: `number` Defined in: [core/query/logevents.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L17) Log record id. `leprop=ids`. *** ### logpage? > `optional` **logpage?**: `number` Defined in: [core/query/logevents.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L29) Page id the log is filed under. `leprop=ids`. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/logevents.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L20) Namespace of the affected page. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/logevents.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L26) Page id of the target; `0` when there is no page. `leprop=ids`. *** ### params? > `optional` **params?**: [`ApiLogEventParams`](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md) Defined in: [core/query/logevents.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L48) Structured log details; shape varies by `type`/`action` — see [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md). `leprop=details`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/logevents.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L63) HTML-rendered comment. `leprop=parsedcomment`. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/logevents.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L36) Revision id associated with the event (when applicable). `leprop=ids`. #### Since MediaWiki 1.40 *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [core/query/logevents.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L66) Change tags. `leprop=tags`. *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/logevents.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L78) The actor is a temporary account. `leprop=user|userid`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/logevents.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L57) Event timestamp. `leprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/logevents.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L23) Title of the affected page. `leprop=title`. *** ### type? > `optional` **type?**: `string` Defined in: [core/query/logevents.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L39) Log type, e.g. `delete`, `move`, `newusers`. `leprop=type`. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/logevents.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L51) Performing user name (or IP). `leprop=user`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/logevents.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L54) Performing user id. `leprop=userid`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md --- > 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: ApiLogEventParams Defined in: [core/query/logparams.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L30) Structured log details — the `params` object of a log event (`leprop=details` on `list=logevents`, `logparams` under the log-info fields of `list=recentchanges` / `list=watchlist`). Each log action writes its own key set, which the server normalizes for the API. The keys below are the ones MediaWiki core itself writes; which of them a row carries depends on its `type`/`action`. The key space is open: extensions and site configuration can register further log actions, and rows written by older MediaWiki versions keep their historical key forms. Unknown keys therefore fall back to `unknown` instead of erroring. Consumers targeting one specific log action — or a site-custom one — can add its keys through interface merging: ## Example ```ts declare module "types-mediawiki-response" { interface ApiLogEventParams { // a site-custom log action, or a legacy key form still in the data "4::target"?: string; } } ``` ## Indexable > \[`key`: `string`]: `unknown` Any other parameter a log action attaches — a log action registered by an extension or site configuration, or a legacy key form on rows written by an older MediaWiki version. ## Properties ### auto? > `optional` **auto?**: `boolean` Defined in: [core/query/logparams.ts:275](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L275) Always `false`: automatic patrols are not logged. *** ### blockId? > `optional` **blockId?**: `number` Defined in: [core/query/logparams.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L73) Id of the block the row created or changed. #### Since MediaWiki 1.44 *** ### cascade? > `optional` **cascade?**: `boolean` Defined in: [core/query/logparams.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L104) Whether cascading protection was requested. *** ### count? > `optional` **count?**: `number` | \{ `files`: `number`; `revisions`: `number`; } Defined in: [core/query/logparams.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L125) How many revisions and archived file versions the undeletion restored (`delete/restore`), how many revisions an import created (`import/upload`, `import/interwiki`), or how many uses a managed tag had (`managetags/activate|deactivate|delete`). *** ### curid? > `optional` **curid?**: `number` Defined in: [core/query/logparams.ts:269](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L269) Revision id that was marked patrolled, on `patrol/patrol` rows. *** ### description? > `optional` **description?**: `string` Defined in: [core/query/logparams.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L101) Content-language protection summary (e.g. `'[edit=autoconfirmed] (indefinite)'`), aimed at machine feeds; the structured data lives in [details](#details). *** ### dest_ns? > `optional` **dest_ns?**: `number` Defined in: [core/query/logparams.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L193) Namespace of the page the history was merged into. *** ### dest_title? > `optional` **dest_title?**: `string` Defined in: [core/query/logparams.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L196) Title of the page the history was merged into. *** ### details? > `optional` **details?**: [`ApiLogProtectDetail`](https://types-mediawiki-response.pages.dev/api/core/ApiLogProtectDetail.md)\[] Defined in: [core/query/logparams.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L107) Protection restrictions in force. *** ### duration? > `optional` **duration?**: `string` Defined in: [core/query/logparams.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L39) Block duration as configured: `'infinity'` or the raw specifier (`'2 weeks'`, …), on `block/block`, `block/reblock`, `suppress/block` and `suppress/reblock` rows. Older rows without one are normalized to `'infinity'`. *** ### duration-l10n? > `optional` **duration-l10n?**: `string` Defined in: [core/query/logparams.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L81) Localized duration text (e.g. `'14 days'`, `'infinite'`), in the requesting user's language. #### Since MediaWiki 1.44 *** ### expiry? > `optional` **expiry?**: `string` Defined in: [core/query/logparams.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L60) Absolute expiry of the block (ISO 8601), on rows with a finite duration. *** ### flags? > `optional` **flags?**: (`"anononly"` | `"nocreate"` | `"noautoblock"` | `"noemail"` | `"nousertalk"` | `"hiddenname"` | `"autoblock"` | `"angry-autoblock"`)\[] Defined in: [core/query/logparams.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L46) Options in force on the block. Rows written by very old MediaWiki versions may carry the legacy values `autoblock` or `angry-autoblock` instead of the current flag set. An array (`[]` when none). *** ### ids? > `optional` **ids?**: (`string` | `number`)\[] Defined in: [core/query/logparams.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L140) Ids of the targeted revisions, file versions or log entries — numbers on current rows, strings on legacy ones. *** ### img_sha1? > `optional` **img_sha1?**: `string` Defined in: [core/query/logparams.ts:261](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L261) SHA-1 of the uploaded file (base36), on `upload/upload`, `upload/overwrite` and `upload/revert` rows. *** ### img_timestamp? > `optional` **img_timestamp?**: `string` Defined in: [core/query/logparams.ts:264](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L264) File timestamp (ISO 8601), which can differ from the row's timestamp. *** ### initialTags? > `optional` **initialTags?**: `string`\[] Defined in: [core/query/logparams.ts:305](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L305) Tags the target carried before the update. *** ### interwiki_ns? > `optional` **interwiki_ns?**: `number` Defined in: [core/query/logparams.ts:250](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L250) Namespace of the source page on the foreign wiki (`import/interwiki`). *** ### interwiki_title? > `optional` **interwiki_title?**: `string` Defined in: [core/query/logparams.ts:253](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L253) Source page on the foreign wiki, with its interwiki prefix (`import/interwiki`). *** ### logid? > `optional` **logid?**: `string` | `number` | `false` Defined in: [core/query/logparams.ts:290](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L290) Log entry the tags were applied to, on rows that targeted one; a raw value like [revid](#revid) — `false` when the update targeted a revision. *** ### mergepoint? > `optional` **mergepoint?**: `string` Defined in: [core/query/logparams.ts:219](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L219) Revision the histories were interleaved at (ISO 8601), on `merge/merge` and `merge/merge-into` rows. *** ### mergerevid? > `optional` **mergerevid?**: `string` | `number` Defined in: [core/query/logparams.ts:227](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L227) Boundary revision id the merge stopped at; stored raw, so it appears as a number or its decimal string. #### Since MediaWiki 1.42 *** ### mergestart? > `optional` **mergestart?**: `string` Defined in: [core/query/logparams.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L237) Timestamp of the first revision kept out of the merge, when a start boundary was used (ISO 8601); the id of that revision is [mergestartid](#mergestartid). Only `merge/merge` rows carry it — `merge/merge-into` rows do not report the start boundary at all. #### Since MediaWiki 1.45 *** ### mergestartid? > `optional` **mergestartid?**: `string` | `number` Defined in: [core/query/logparams.ts:245](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L245) First revision id kept out of the merge; stored raw like [mergerevid](#mergerevid). #### Since MediaWiki 1.45 *** ### new? > `optional` **new?**: [`ApiLogRevDelVisibility`](https://types-mediawiki-response.pages.dev/api/core/ApiLogRevDelVisibility.md) Defined in: [core/query/logparams.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L146) Visibility state after the change. *** ### newgroups? > `optional` **newgroups?**: `string`\[] Defined in: [core/query/logparams.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L165) Groups after the change. *** ### newlanguage? > `optional` **newlanguage?**: `string` Defined in: [core/query/logparams.ts:321](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L321) Page language after the change; also `[def]`-suffixed when set to default. *** ### newmetadata? > `optional` **newmetadata?**: [`ApiLogGroupMetadata`](https://types-mediawiki-response.pages.dev/api/core/ApiLogGroupMetadata.md)\[] Defined in: [core/query/logparams.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L177) Per-group membership expiry, parallel to [newgroups](#newgroups); `[]` when permanent. Absent on `rights/autopromote` rows. *** ### newmodel? > `optional` **newmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/logparams.ts:188](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L188) Content model after the change. *** ### old? > `optional` **old?**: [`ApiLogRevDelVisibility`](https://types-mediawiki-response.pages.dev/api/core/ApiLogRevDelVisibility.md) Defined in: [core/query/logparams.ts:143](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L143) Visibility state before the change. *** ### oldgroups? > `optional` **oldgroups?**: `string`\[] Defined in: [core/query/logparams.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L162) Groups the target user belonged to before the change (on `rights/rights` and `rights/autopromote` rows). *** ### oldlanguage? > `optional` **oldlanguage?**: `string` Defined in: [core/query/logparams.ts:318](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L318) Page language before the change, on `pagelang/pagelang` rows; the wiki's default language carries a `[def]` suffix (e.g. `'en[def]'`). *** ### oldmetadata? > `optional` **oldmetadata?**: [`ApiLogGroupMetadata`](https://types-mediawiki-response.pages.dev/api/core/ApiLogGroupMetadata.md)\[] Defined in: [core/query/logparams.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L171) Per-group membership expiry, parallel to [oldgroups](#oldgroups); `[]` when the memberships were all permanent. Absent on `rights/autopromote` rows. *** ### oldmodel? > `optional` **oldmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/logparams.ts:185](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L185) Content model before the change (on `contentmodel/change` and `contentmodel/new` rows). *** ### oldtitle_ns? > `optional` **oldtitle_ns?**: `number` Defined in: [core/query/logparams.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L112) Namespace of the title the protection moved away from. *** ### oldtitle_title? > `optional` **oldtitle_title?**: `string` Defined in: [core/query/logparams.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L115) Title the protection moved away from. *** ### previd? > `optional` **previd?**: `number` Defined in: [core/query/logparams.ts:272](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L272) Revision id the patrolled one followed. *** ### restrictions? > `optional` **restrictions?**: [`ApiLogBlockRestrictions`](https://types-mediawiki-response.pages.dev/api/core/ApiLogBlockRestrictions.md) Defined in: [core/query/logparams.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L66) Scope of a partial block; absent for sitewide blocks. *** ### revid? > `optional` **revid?**: `string` | `number` | `false` Defined in: [core/query/logparams.ts:284](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L284) Revision the tags were applied to (`tag/update` rows); a raw value from the tagging caller, so forms vary (a number, its decimal string, or `false` when the update targeted a log entry). *** ### sitewide? > `optional` **sitewide?**: `boolean` Defined in: [core/query/logparams.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L63) Whether the block covers the whole site (`false` for a partial block). *** ### src_ns? > `optional` **src_ns?**: `number` Defined in: [core/query/logparams.ts:206](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L206) Namespace of the page whose history was merged in (`merge/merge-into` row filed on the destination page). #### Since MediaWiki 1.45 *** ### src_title? > `optional` **src_title?**: `string` Defined in: [core/query/logparams.ts:213](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L213) Title of the page whose history was merged in (`merge/merge-into`). #### Since MediaWiki 1.45 *** ### suppressredirect? > `optional` **suppressredirect?**: `boolean` Defined in: [core/query/logparams.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L92) Whether the move left no redirect behind. *** ### tag? > `optional` **tag?**: `string` Defined in: [core/query/logparams.ts:310](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L310) Name of the managed tag (`managetags/create|activate|deactivate|delete`). *** ### tagsAdded? > `optional` **tagsAdded?**: `string`\[] Defined in: [core/query/logparams.ts:293](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L293) Tags the update added. *** ### tagsAddedCount? > `optional` **tagsAddedCount?**: `number` Defined in: [core/query/logparams.ts:296](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L296) How many tags [tagsAdded](#tagsadded) holds. *** ### tagsRemoved? > `optional` **tagsRemoved?**: `string`\[] Defined in: [core/query/logparams.ts:299](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L299) Tags the update removed. *** ### tagsRemovedCount? > `optional` **tagsRemovedCount?**: `number` Defined in: [core/query/logparams.ts:302](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L302) How many tags [tagsRemoved](#tagsremoved) holds. *** ### target_ns? > `optional` **target_ns?**: `number` Defined in: [core/query/logparams.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L86) Namespace of the move destination (on `move/move` and `move/move_redir` rows). *** ### target_title? > `optional` **target_title?**: `string` Defined in: [core/query/logparams.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L89) Title of the move destination. *** ### type? > `optional` **type?**: `"revision"` | `"archive"` | `"oldimage"` | `"filearchive"` | `"logging"` Defined in: [core/query/logparams.ts:134](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L134) What the visibility change targeted: `'revision'`, `'archive'`, `'oldimage'` or `'filearchive'` on `…/revision` rows; `'logging'` on `…/event` rows. *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/logparams.ts:154](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L154) Id of the account the row reports (on `newusers/create`, `newusers/create2` and `newusers/autocreate` rows). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogGroupMetadata.md --- > 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: ApiLogGroupMetadata Defined in: [core/query/logparams.ts:386](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L386) One group-membership change with its expiry (`oldmetadata`/`newmetadata` entry). ## Properties ### expiry > **expiry**: `string` Defined in: [core/query/logparams.ts:391](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L391) When the membership lapses. *** ### group > **group**: `string` Defined in: [core/query/logparams.ts:388](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L388) Group name. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogPageRef.md --- > 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: ApiLogPageRef Defined in: [core/query/logparams.ts:332](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L332) One page a partial block is restricted to (`restrictions.pages` entry). ## Properties ### page_ns > **page_ns**: `number` Defined in: [core/query/logparams.ts:334](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L334) Namespace index. *** ### page_title > **page_title**: `string` Defined in: [core/query/logparams.ts:337](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L337) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogProtectDetail.md --- > 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: ApiLogProtectDetail Defined in: [core/query/logparams.ts:353](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L353) One protection restriction (`details` entry on `protect/protect`, `protect/modify`). ## Properties ### cascade? > `optional` **cascade?**: `boolean` Defined in: [core/query/logparams.ts:364](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L364) Whether this restriction cascades; absent on `'create'` entries. *** ### expiry > **expiry**: `string` Defined in: [core/query/logparams.ts:361](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L361) When the protection lapses (ISO 8601), or `'infinite'`. *** ### level > **level**: `string` Defined in: [core/query/logparams.ts:358](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L358) Protection level (e.g. `'autoconfirmed'`, `'sysop'`). *** ### type > **type**: `string` Defined in: [core/query/logparams.ts:355](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L355) Action being restricted (e.g. `'edit'`); `'create'` for title protection. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogRevDelVisibility.md --- > 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: ApiLogRevDelVisibility Defined in: [core/query/logparams.ts:368](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L368) One visibility state (`old`/`new` on a RevisionDelete row). ## Properties ### bitmask > **bitmask**: `number` Defined in: [core/query/logparams.ts:370](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L370) Raw visibility bitfield. *** ### comment > **comment**: `boolean` Defined in: [core/query/logparams.ts:376](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L376) Whether the edit summary is hidden. *** ### content > **content**: `boolean` Defined in: [core/query/logparams.ts:373](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L373) Whether the content is hidden. *** ### restricted > **restricted**: `boolean` Defined in: [core/query/logparams.ts:382](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L382) Whether only suppressors can unhide. *** ### user > **user**: `boolean` Defined in: [core/query/logparams.ts:379](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logparams.ts#L379) Whether the performer is hidden. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLoginResponse.md --- > 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: ApiLoginResponse Defined in: [core/login.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/login.ts#L18) Response of the deprecated `action=login`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### login > **login**: `object` Defined in: [core/login.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/login.ts#L20) Result of `action=login`. #### lguserid? > `optional` **lguserid?**: `number` User id of the logged-in account (legacy `lguserid` spelling). #### lgusername? > `optional` **lgusername?**: `string` User name of the logged-in account (legacy `lgusername` spelling). #### reason? > `optional` **reason?**: `string` | [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) Why the login failed, emitted when `result` is `Failed` or `Aborted`: a plain string under the default (`bc`) `errorformat`, an [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one. #### result > **result**: `string` & `object` | `"Success"` | `"Failed"` | `"NeedToken"` | `"WrongToken"` | `"Aborted"` Login outcome. #### token? > `optional` **token?**: `string` Login token echoed back on a `NeedToken` round trip. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiLogoutResponse.md --- > 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: ApiLogoutResponse Defined in: [core/logout.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/logout.ts#L16) Response of `action=logout`. No payload keys are emitted on success; the type exists so the shape is explicit (the `logout.status` object older builds returned is gone in 1.43). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMagicWord.md --- > 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: ApiMagicWord Defined in: [core/query/siteinfo.ts:548](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L548) One magic word (`siprop=magicwords`). ## Properties ### aliases > **aliases**: `string`\[] Defined in: [core/query/siteinfo.ts:553](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L553) Alias patterns, with `$1` for the argument. *** ### case-sensitive > **case-sensitive**: `boolean` Defined in: [core/query/siteinfo.ts:556](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L556) Whether matching is case-sensitive. A real `boolean`. *** ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:550](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L550) Internal name, e.g. `img_lossy`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsOperation.md --- > 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. # Type Alias: ApiManageTagsOperation > **ApiManageTagsOperation** = `"activate"` | `"create"` | `"deactivate"` | `"delete"` Defined in: [core/managetags.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/managetags.ts#L14) `action=managetags` operation, echoed from the request. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsResponse.md --- > 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: ApiManageTagsResponse Defined in: [core/managetags.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/managetags.ts#L17) Response of `action=managetags`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### managetags > **managetags**: `object` Defined in: [core/managetags.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/managetags.ts#L19) Result of `action=managetags`. #### logid? > `optional` **logid?**: `number` Log entry id recorded for the operation. #### operation > **operation**: [`ApiManageTagsOperation`](https://types-mediawiki-response.pages.dev/api/core/ApiManageTagsOperation.md) The operation that was performed. #### success > **success**: `boolean` Whether the operation succeeded. #### tag > **tag**: `string` Tag name acted on. #### warnings? > `optional` **warnings?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Non-fatal messages (e.g. a deprecation notice), shaped per the request's `errorformat`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMergeHistoryResponse.md --- > 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: ApiMergeHistoryResponse Defined in: [core/mergehistory.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/mergehistory.ts#L12) Response of `action=mergehistory`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### mergehistory > **mergehistory**: `object` Defined in: [core/mergehistory.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/mergehistory.ts#L14) Result of `action=mergehistory`. #### from > **from**: `string` Source page title (history moved out of). #### reason > **reason**: `string` Reason supplied with the merge; `''` when none was given. #### timestamp > **timestamp**: `string` Cutoff timestamp up to which revisions were merged, as ISO 8601. Echoes the `timestamp` parameter when supplied; with a full-history merge (no `timestamp` given) it is the current server time. #### to > **to**: `string` Destination page title (history merged into). *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md --- > 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: ApiMessage Defined in: [envelope/index.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L30) 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](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L32) Machine-readable code, e.g. `badvalue`, `unrecognizedparams`. *** ### data? > `optional` **data?**: `unknown` Defined in: [envelope/index.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L50) Extra structured data some messages attach. *** ### html? > `optional` **html?**: `string` Defined in: [envelope/index.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L38) Parsed message HTML (`errorformat=html`). *** ### key? > `optional` **key?**: `string` Defined in: [envelope/index.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L41) i18n message key (`errorformat=raw`). *** ### module? > `optional` **module?**: `string` Defined in: [envelope/index.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L47) Module the message originated from, e.g. `main`, `query+info`. *** ### params? > `optional` **params?**: [`ApiMessageParam`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md)\[] Defined in: [envelope/index.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L44) i18n message parameters (`errorformat=raw`). *** ### text? > `optional` **text?**: `string` Defined in: [envelope/index.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L35) Rendered message (`errorformat=plaintext`/`wikitext`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md --- > 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. # Type Alias: ApiMessageParam > **ApiMessageParam** = `string` | `number` | [`ApiRawMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiRawMessage.md) | [`ApiMessageParamSpec`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParamSpec.md) Defined in: [envelope/index.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L22) A single i18n message parameter under `errorformat=raw`: a scalar, a bare nested message ([ApiRawMessage](https://types-mediawiki-response.pages.dev/api/core/ApiRawMessage.md), produced when a message sits inside a list), or an object spec ([ApiMessageParamSpec](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParamSpec.md)). Plain-text parameters are inlined as scalars, and a numeric parameter may arrive as a bare number or a `{ num }` spec. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMessageParamSpec.md --- > 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. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiModernErrorResponse.md --- > 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: ApiModernErrorResponse Defined in: [envelope/index.ts:209](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L209) Error response under a modern `errorformat`: an `errors` array plus top-level `docref`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### docref? > `optional` **docref?**: `string` Defined in: [envelope/index.ts:214](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L214) Docs link plus deprecation notices (top-level under modern `errorformat`). *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### errors > **errors**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] Defined in: [envelope/index.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L211) Every error raised by the request; at least one entry is present. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### trace? > `optional` **trace?**: `string` Defined in: [envelope/index.ts:217](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L217) PHP backtrace, when `$wgShowExceptionDetails` is on (non-usage exceptions). *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMoveResponse.md --- > 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: ApiMoveResponse Defined in: [core/move.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L76) Response of `action=move`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### move > **move**: [`ApiMoveResult`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveResult.md) Defined in: [core/move.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L78) Result of `action=move`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMoveResult.md --- > 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: ApiMoveResult Defined in: [core/move.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L36) The `move` object of a successful `action=move` response. ## Properties ### from > **from**: `string` Defined in: [core/move.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L38) Original title. *** ### moveoverredirect > **moveoverredirect**: `boolean` Defined in: [core/move.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L50) Whether the destination title already existed (redirect or not). A real `boolean`. *** ### reason > **reason**: `string` Defined in: [core/move.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L44) Move reason (the edit summary); `''` when none was supplied. *** ### redirectcreated > **redirectcreated**: `boolean` Defined in: [core/move.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L47) Whether a redirect was left at `from`. A real `boolean`. *** ### subpages? > `optional` **subpages?**: [`ApiMoveSubpageErrors`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpageErrors.md) | [`ApiMoveSubpage`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpage.md)\[] Defined in: [core/move.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L69) Subpage move outcome (`movesubpages=1`). `formatversion=2` returns either an array of per-subpage outcomes or an object of errors, so both shapes are allowed. *** ### subpages-talk? > `optional` **subpages-talk?**: [`ApiMoveSubpageErrors`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpageErrors.md) | [`ApiMoveSubpage`](https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpage.md)\[] Defined in: [core/move.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L72) Talk subpage outcome (`movesubpages=1` + `movetalk=1`); same polymorphism as `subpages`. *** ### talkfrom? > `optional` **talkfrom?**: `string` Defined in: [core/move.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L53) Original talk-page title (present with `movetalk=1`). *** ### talkmove-errors? > `optional` **talkmove-errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/move.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L62) Why the talk-page move failed, instead of `talkfrom`/`talkto`, shaped per the request's `errorformat`. *** ### talkmoveoverredirect? > `optional` **talkmoveoverredirect?**: `boolean` Defined in: [core/move.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L59) Whether the talk-page destination already existed (redirect or not). A real `boolean`. *** ### talkto? > `optional` **talkto?**: `string` Defined in: [core/move.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L56) New talk-page title (present with `movetalk=1`). *** ### to > **to**: `string` Defined in: [core/move.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L41) New title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpage.md --- > 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: ApiMoveSubpage Defined in: [core/move.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L18) One subpage move outcome within `subpages`/`subpages-talk`. ## Properties ### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/move.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L26) Why the subpage did not move, when it failed, shaped per the request's `errorformat`. *** ### from? > `optional` **from?**: `string` Defined in: [core/move.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L20) Old subpage title. *** ### to? > `optional` **to?**: `string` Defined in: [core/move.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L23) New subpage title, when the subpage moved. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiMoveSubpageErrors.md --- > 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: ApiMoveSubpageErrors Defined in: [core/move.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L30) The object form of `subpages`, returned only when the whole move failed. ## Properties ### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/move.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/move.ts#L32) Why no subpage could be moved, shaped per the request's `errorformat`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiNamespaceAlias.md --- > 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: ApiNamespaceAlias Defined in: [core/query/siteinfo.ts:434](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L434) One localized namespace alias (`siprop=namespacealiases`). ## Properties ### alias > **alias**: `string` Defined in: [core/query/siteinfo.ts:439](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L439) The alias, e.g. `Image`. *** ### id > **id**: `number` Defined in: [core/query/siteinfo.ts:436](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L436) Alias of the namespace this entry belongs to, not a page id. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiNamespaceInfo.md --- > 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: ApiNamespaceInfo Defined in: [core/query/siteinfo.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L24) One namespace entry in `query.namespaces`, keyed by namespace index. ## Properties ### canonical? > `optional` **canonical?**: `string` Defined in: [core/query/siteinfo.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L29) Canonical name (e.g. `Talk`), the language-independent identifier. *** ### case > **case**: [`CaseSensitivity`](https://types-mediawiki-response.pages.dev/api/core/CaseSensitivity.md) Defined in: [core/query/siteinfo.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L35) Title case-sensitivity within the namespace. *** ### content > **content**: `boolean` Defined in: [core/query/siteinfo.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L41) Whether the namespace is a content namespace. A real `boolean`. *** ### defaultcontentmodel? > `optional` **defaultcontentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/siteinfo.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L54) Default content model for the namespace, e.g. `javascript`. Absent for wikitext. *** ### id > **id**: `number` Defined in: [core/query/siteinfo.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L26) Namespace index. *** ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L32) Localized name for this wiki. *** ### namespaceprotection? > `optional` **namespaceprotection?**: `string` Defined in: [core/query/siteinfo.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L51) Right required to edit this namespace, e.g. `editinterface` for `MediaWiki:`. Absent when the namespace is unrestricted. A single right, or several joined with `|` when the config lists more than one. *** ### nonincludable > **nonincludable**: `boolean` Defined in: [core/query/siteinfo.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L44) Whether pages here are non-includable. A real `boolean`. *** ### subpages > **subpages**: `boolean` Defined in: [core/query/siteinfo.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L38) Whether subpages are allowed. A real `boolean` under `formatversion=2`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiNamespaces.md --- > 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: ApiNamespaces Defined in: [core/query/siteinfo.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L61) `query.namespaces`: a map from namespace index to its info. Negative indexes are pseudo-namespaces; some indexes are absent (gaps). ## Indexable > \[`nsIndex`: `string`]: [`ApiNamespaceInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiNamespaceInfo.md) | `undefined` Info for the namespace index the key names. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiOptionsResponse.md --- > 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: ApiOptionsResponse Defined in: [core/options.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/options.ts#L14) Response of `action=options`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### options > **options**: `"success"` Defined in: [core/options.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/options.ts#L16) Success sentinel (`"success"`); failures come back as a top-level error. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPage.md --- > 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: ApiPage Defined in: [core/query/index.ts:404](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L404) A `query.pages` entry carrying the union of all covered `prop=` fields. `prop=` modules widen this via declaration merging (see `./info`); every field is optional because pages may be missing/invalid and because a response only contains the props that were requested. For a view scoped to the props you actually requested, use [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md). ## Extends - [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`ApiPageContributors`](https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md).[`ApiPageImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md) ## Properties ### actions? > `optional` **actions?**: `unknown`\[] | `Record`\<`string`, `boolean` | [`ApiActionPermission`](https://types-mediawiki-response.pages.dev/api/core/ApiActionPermission.md)\[]> Defined in: [core/query/info.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L142) Per-action permission test results, keyed by action name. Set by `intestactions=`: `intestactionsdetail=boolean` yields a `boolean` per action, while `full`/`quick` yields the array of blocking messages (empty when the action is allowed). A PHP map, so an empty result serializes as `[]`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`actions`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#actions) *** ### anoncontributors? > `optional` **anoncontributors?**: `number` Defined in: [core/query/contributors.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L29) Number of anonymous (IP) contributors to the page (`prop=contributors`). #### Inherited from [`ApiPageContributors`](https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md).[`anoncontributors`](https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md#anoncontributors) *** ### associatedpage? > `optional` **associatedpage?**: `string` Defined in: [core/query/info.ts:218](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L218) Related page: the talk page for a subject, or vice versa. `inprop=associatedpage`; subject/talk namespaces only — not emitted on special or `Media:` pages. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`associatedpage`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#associatedpage) *** ### badfile? > `optional` **badfile?**: `boolean` Defined in: [core/query/imageinfo.ts:263](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L263) Whether the file is on the "bad images" list (`$wgBadImageList`). `iiprop=badfile` — a real `boolean`, and a **page-level sibling** of [ApiPage.imageinfo](#imageinfo), not a member of the imageinfo entry. #### Inherited from [`ApiPageImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md).[`badfile`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md#badfile) *** ### canonicalurl? > `optional` **canonicalurl?**: `string` Defined in: [core/query/info.ts:233](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L233) Canonical URL. `inprop=url`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`canonicalurl`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#canonicalurl) *** ### categories? > `optional` **categories?**: [`ApiCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiCategory.md)\[] Defined in: [core/query/categories.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categories.ts#L33) Categories the page belongs to (`prop=categories`). *** ### categoryinfo? > `optional` **categoryinfo?**: [`ApiCategoryInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiCategoryInfo.md) Defined in: [core/query/categoryinfo.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categoryinfo.ts#L29) Category membership counts (`prop=categoryinfo`). *** ### categorysnippet? > `optional` **categorysnippet?**: `string` Defined in: [core/query/search.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L56) Snippet of the matching category. `srprop=categorysnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`categorysnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#categorysnippet) *** ### contentmodel? > `optional` **contentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/info.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L67) Content model of the page's current revision. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`contentmodel`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#contentmodel) *** ### contributors? > `optional` **contributors?**: [`ApiContributor`](https://types-mediawiki-response.pages.dev/api/core/ApiContributor.md)\[] Defined in: [core/query/contributors.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L26) Distinct logged-in contributors to the page (`prop=contributors`). #### Inherited from [`ApiPageContributors`](https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md).[`contributors`](https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md#contributors) *** ### deletedrevisions? > `optional` **deletedrevisions?**: `ApiRevision`\[] Defined in: [core/query/deletedrevisions.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevisions.ts#L20) Deleted revisions of the page (`prop=deletedrevisions`). *** ### description? > `optional` **description?**: `string` Defined in: [extensions/description.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/description.ts#L22) Short description of the page, in the wiki's content language (`prop=description`). *** ### descriptionsource? > `optional` **descriptionsource?**: [`DescriptionSource`](https://types-mediawiki-response.pages.dev/api/extensions/description/DescriptionSource.md) Defined in: [extensions/description.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/description.ts#L25) Which source supplied the [description](#description): `local` or an upstream repo. *** ### displaytitle? > `optional` **displaytitle?**: `string` Defined in: [core/query/info.ts:236](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L236) HTML title used for display. `inprop=displaytitle`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`displaytitle`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#displaytitle) *** ### duplicatefiles? > `optional` **duplicatefiles?**: [`ApiDuplicateFile`](https://types-mediawiki-response.pages.dev/api/core/ApiDuplicateFile.md)\[] Defined in: [core/query/duplicatefiles.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/duplicatefiles.ts#L32) Files whose content matches this one (`prop=duplicatefiles`). *** ### editintro? > `optional` **editintro?**: `Record`\<`string`, `string`> Defined in: [core/query/info.ts:205](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L205) Notices the edit form should show, keyed by message name (e.g. `newarticletext`) with HTML values. Drawn from the whole edit-form intro message set — `newarticletext`, `talkpagetext`, per-namespace editnotices, `Editintro` pages, … — not only `MediaWiki:Editintro*` pages. `inprop=editintro`; only for a single title per query. #### Since MediaWiki 1.41 #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`editintro`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#editintro) *** ### editurl? > `optional` **editurl?**: `string` Defined in: [core/query/info.ts:230](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L230) Edit-page URL. `inprop=url`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`editurl`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#editurl) *** ### extensiondata? > `optional` **extensiondata?**: `unknown` Defined in: [core/query/search.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L74) Search-backend extension data, keyed by augmentor name. `srprop=extensiondata`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`extensiondata`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#extensiondata) *** ### extlinks? > `optional` **extlinks?**: [`ApiExternalLink`](https://types-mediawiki-response.pages.dev/api/core/ApiExternalLink.md)\[] Defined in: [core/query/extlinks.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/extlinks.ts#L17) External links on this page (`prop=extlinks`). *** ### extract? > `optional` **extract?**: `string` Defined in: [extensions/extracts.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/extracts.ts#L25) Page excerpt, limited to the intro with `exintro` (`prop=extracts`). *** ### fileusage? > `optional` **fileusage?**: [`ApiFileUsage`](https://types-mediawiki-response.pages.dev/api/core/ApiFileUsage.md)\[] Defined in: [core/query/fileusage.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/fileusage.ts#L29) Local pages using this file (`prop=fileusage`). *** ### flagged? > `optional` **flagged?**: [`ApiPageFlagged`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiPageFlagged.md) Defined in: [extensions/flaggedrevs.ts:210](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L210) Review and stabilization state of the page (`prop=flagged`). *** ### fullurl? > `optional` **fullurl?**: `string` Defined in: [core/query/info.ts:227](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L227) Fully-resolved canonical article URL. `inprop=url`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`fullurl`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#fullurl) *** ### globalusage? > `optional` **globalusage?**: [`ApiGlobalUsage`](https://types-mediawiki-response.pages.dev/api/extensions/globalusage/ApiGlobalUsage.md)\[] Defined in: [extensions/globalusage.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L43) Wikis using this image, one entry per using page (`prop=globalusage`). *** ### imageinfo? > `optional` **imageinfo?**: [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md)\[] Defined in: [core/query/imageinfo.ts:266](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L266) Image/file info entries (`prop=imageinfo`); usually one for the current file. #### Inherited from [`ApiPageImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md).[`imageinfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md#imageinfo) *** ### imagerepository? > `optional` **imagerepository?**: `string` & `object` | `"local"` | `"shared"` Defined in: [core/query/imageinfo.ts:256](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L256) Where the file is hosted: the repository name, `local` for this wiki; `''` when the file does not exist. Framework field for file pages. #### Inherited from [`ApiPageImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md).[`imagerepository`](https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md#imagerepository) *** ### images? > `optional` **images?**: [`ApiUsedImage`](https://types-mediawiki-response.pages.dev/api/core/ApiUsedImage.md)\[] Defined in: [core/query/images.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/images.ts#L21) Files embedded by this page (`prop=images`). *** ### index? > `optional` **index?**: `number` Defined in: [core/query/index.ts:411](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L411) 1-based rank of the page in the generator's ordering; injected by the query framework for `generator=search` and `generator=prefixsearch`, absent otherwise. A page reached through a redirect takes the smaller of the two ranks. *** ### invalid? > `optional` **invalid?**: `true` Defined in: [core/query/index.ts:384](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L384) `true` when the supplied title is not a valid title. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`invalid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#invalid) *** ### invalidreason? > `optional` **invalidreason?**: `string` | [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) Defined in: [core/query/index.ts:390](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L390) Why the title is `invalid`: a plain string under the default (`bc`) `errorformat`, an [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`invalidreason`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#invalidreason) *** ### isfilematch? > `optional` **isfilematch?**: `boolean` Defined in: [core/query/search.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L71) Whether the hit matched a file. `srprop=isfilematch`; a real `boolean`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`isfilematch`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#isfilematch) *** ### iwlinks? > `optional` **iwlinks?**: [`ApiInterwikiLink`](https://types-mediawiki-response.pages.dev/api/core/ApiInterwikiLink.md)\[] Defined in: [core/query/iwlinks.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwlinks.ts#L23) Interwiki links on the page (`prop=iwlinks`). *** ### known? > `optional` **known?**: `true` Defined in: [core/query/index.ts:381](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L381) `true` when the page does not exist but its content is known (e.g. a defined but unsaved interface message). Emitted by the framework itself, without requesting `prop=info`. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`known`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#known) *** ### langlinks? > `optional` **langlinks?**: [`ApiLangLink`](https://types-mediawiki-response.pages.dev/api/core/ApiLangLink.md)\[] Defined in: [core/query/langlinks.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langlinks.ts#L35) Interlanguage links from this page (`prop=langlinks`). *** ### lastrevid? > `optional` **lastrevid?**: `number` Defined in: [core/query/info.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L82) Revision id of the latest revision. Existing pages only. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`lastrevid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#lastrevid) *** ### length? > `optional` **length?**: `number` Defined in: [core/query/info.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L85) Length of the page content in bytes. Existing pages only. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`length`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#length) *** ### linkclasses? > `optional` **linkclasses?**: `string`\[] Defined in: [core/query/info.ts:250](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L250) CSS classes to apply to links to this page (core marks redirects `mw-redirect`; extensions may add more). `inprop=linkclasses`; emitted for every requested page, `[]` when there is no class for it. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`linkclasses`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#linkclasses) *** ### links? > `optional` **links?**: [`ApiPageLink`](https://types-mediawiki-response.pages.dev/api/core/ApiPageLink.md)\[] Defined in: [core/query/links.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/links.ts#L23) Pages linked-to by this page (`prop=links`). *** ### linkshere? > `optional` **linkshere?**: [`ApiLinksHere`](https://types-mediawiki-response.pages.dev/api/core/ApiLinksHere.md)\[] Defined in: [core/query/linkshere.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/linkshere.ts#L28) Pages linking to this page (`prop=linkshere`). *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/index.ts:374](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L374) `true` when the page does not exist. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`missing`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#missing) *** ### mmcontent? > `optional` **mmcontent?**: [`ApiMmContent`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMmContent.md) Defined in: [extensions/massmessage.ts:120](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L120) Parsed delivery list content (only on `MassMessageListContent` pages). *** ### new? > `optional` **new?**: `true` Defined in: [core/query/info.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L94) `true` when the page is in the new-pages list (no other page links to it and it has a single revision). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) — absent for established pages. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`new`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#new) *** ### notificationtimestamp? > `optional` **notificationtimestamp?**: `string` Defined in: [core/query/info.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L158) When the requesting user last saw the page. An **empty string** when never visited (or when notifications are off), otherwise a timestamp. `inprop=notificationtimestamp`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`notificationtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#notificationtimestamp) *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/index.ts:368](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L368) Namespace index. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#ns) *** ### original? > `optional` **original?**: [`ApiThumbnail`](https://types-mediawiki-response.pages.dev/api/extensions/pageimages/ApiThumbnail.md) Defined in: [extensions/pageimages.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L40) Representative image at its own dimensions (`piprop=original`). *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/index.ts:365](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L365) Page id. Absent when the id is unknown: a missing page requested by page id keeps its `pageid` alongside `missing`, while title-supplied missing/invalid pages and special pages carry no `pageid`. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#pageid) *** ### pageimage? > `optional` **pageimage?**: `string` Defined in: [extensions/pageimages.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L34) Name of the page's representative image (`piprop=name`). *** ### pagelanguage? > `optional` **pagelanguage?**: `string` Defined in: [core/query/info.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L70) Page language code, e.g. `en`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`pagelanguage`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#pagelanguage) *** ### pagelanguagedir? > `optional` **pagelanguagedir?**: `"ltr"` | `"rtl"` Defined in: [core/query/info.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L76) Writing direction of the page language. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`pagelanguagedir`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#pagelanguagedir) *** ### pagelanguagehtmlcode? > `optional` **pagelanguagehtmlcode?**: `string` Defined in: [core/query/info.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L73) HTML `lang` attribute value for the page language. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`pagelanguagehtmlcode`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#pagelanguagehtmlcode) *** ### pageprops? > `optional` **pageprops?**: [`ApiPageProps`](https://types-mediawiki-response.pages.dev/api/core/ApiPageProps.md) Defined in: [core/query/pageprops.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageprops.ts#L19) Page properties (`prop=pageprops`), keyed by property name. *** ### pageviews? > `optional` **pageviews?**: [`ApiViewCounts`](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiViewCounts.md) Defined in: [extensions/pageviews.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L54) `prop=pageviews` (`pvipdays`, default 60): per-day view counts for this page. *** ### ~~preload?~~ > `optional` **preload?**: `string` Defined in: [core/query/info.ts:176](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L176) Text pre-filled into the edit box for a missing page, from the `EditFormPreloadText` hook. `''` when the page exists. `inprop=preload`. #### Deprecated since MediaWiki 1.41 in favour of [preloadcontent](#preloadcontent), which also reports the content model and format. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`preload`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#preload) *** ### preloadcontent? > `optional` **preloadcontent?**: [`ApiPreloadedContent`](https://types-mediawiki-response.pages.dev/api/core/ApiPreloadedContent.md) Defined in: [core/query/info.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L186) Content the edit form would preload: for a page that does not exist yet, or for an existing page when a new section would be added (`preloadnewsection=1`). `inprop=preloadcontent`; only for a single title/revision per query. #### Since MediaWiki 1.41 #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`preloadcontent`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#preloadcontent) *** ### preloadisdefault? > `optional` **preloadisdefault?**: `boolean` Defined in: [core/query/info.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L194) Whether [preloadcontent](#preloadcontent) is identical to the page's default content, in which case saving it would be a no-op. `inprop=preloadcontent`. #### Since MediaWiki 1.41 #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`preloadisdefault`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#preloadisdefault) *** ### protection? > `optional` **protection?**: [`ApiPageProtection`](https://types-mediawiki-response.pages.dev/api/core/ApiPageProtection.md)\[] Defined in: [core/query/info.ts:208](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L208) Protection entries; empty array when unrestricted. `inprop=protection`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`protection`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#protection) *** ### ~~readable?~~ > `optional` **readable?**: `boolean` Defined in: [core/query/info.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L166) Whether the current user may read the page. A real `boolean` (`false` included). `inprop=readable`. #### Deprecated since MediaWiki 1.32; use `intestactions=read` instead. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`readable`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#readable) *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/info.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L88) `true` when the page is a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) (appears only when true). #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`redirect`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#redirect) *** ### redirects? > `optional` **redirects?**: [`ApiRedirect`](https://types-mediawiki-response.pages.dev/api/core/ApiRedirect.md)\[] Defined in: [core/query/redirects.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/redirects.ts#L30) Redirects pointing at this page (`prop=redirects`). *** ### redirectsnippet? > `optional` **redirectsnippet?**: `string` Defined in: [core/query/search.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L68) HTML snippet of the redirect target title. `srprop=redirectsnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`redirectsnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#redirectsnippet) *** ### redirecttitle? > `optional` **redirecttitle?**: `string` Defined in: [core/query/search.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L65) Title of the redirect target, if this hit redirects. `srprop=redirecttitle`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`redirecttitle`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#redirecttitle) *** ### restrictiontypes? > `optional` **restrictiontypes?**: `string`\[] Defined in: [core/query/info.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L211) Restriction types that apply, e.g. `edit`, `move`, `create`. `inprop=protection`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`restrictiontypes`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#restrictiontypes) *** ### revisions? > `optional` **revisions?**: `ApiRevision`\[] Defined in: [core/query/revisions.ts:213](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L213) Revisions of the page (`prop=revisions`), newest first unless `rvdir=newer`. *** ### sectionsnippet? > `optional` **sectionsnippet?**: `string` Defined in: [core/query/search.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L62) HTML snippet of the section heading. `srprop=sectionsnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`sectionsnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#sectionsnippet) *** ### sectiontitle? > `optional` **sectiontitle?**: `string` Defined in: [core/query/search.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L59) Title of the section the match is in. `srprop=sectiontitle`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`sectiontitle`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#sectiontitle) *** ### size? > `optional` **size?**: `number` Defined in: [core/query/search.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L41) Page size in bytes. `srprop=size`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`size`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#size) *** ### snippet? > `optional` **snippet?**: `string` Defined in: [core/query/search.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L50) HTML snippet of the match, with highlights. `srprop=snippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`snippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#snippet) *** ### special? > `optional` **special?**: `true` Defined in: [core/query/index.ts:393](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L393) `true` for pages in a special namespace. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`special`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#special) *** ### subjectid? > `optional` **subjectid?**: `number` Defined in: [core/query/info.ts:224](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L224) Page id of the associated subject page. `inprop=subjectid` (talk pages only). #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`subjectid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#subjectid) *** ### talkid? > `optional` **talkid?**: `number` Defined in: [core/query/info.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L221) Page id of the associated talk page. `inprop=talkid` (subject pages only). #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`talkid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#talkid) *** ### templates? > `optional` **templates?**: [`ApiTemplate`](https://types-mediawiki-response.pages.dev/api/core/ApiTemplate.md)\[] Defined in: [core/query/templates.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/templates.ts#L21) Pages transcluded by this page (`prop=templates`). *** ### terms? > `optional` **terms?**: [`ApiPageTerms`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiPageTerms.md) Defined in: [extensions/wikibase.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L108) `prop=pageterms`: terms of the entity linked to this page. *** ### thumbnail? > `optional` **thumbnail?**: [`ApiThumbnail`](https://types-mediawiki-response.pages.dev/api/extensions/pageimages/ApiThumbnail.md) Defined in: [extensions/pageimages.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L37) Representative image, scaled to `pithumbsize` (`piprop=thumbnail`). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/search.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L47) Last-edit timestamp. `srprop=timestamp`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`timestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#timestamp) *** ### title? > `optional` **title?**: `string` Defined in: [core/query/index.ts:371](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L371) Full, normalized page title. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#title) *** ### titlesnippet? > `optional` **titlesnippet?**: `string` Defined in: [core/query/search.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L53) HTML snippet of the title. `srprop=titlesnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`titlesnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#titlesnippet) *** ### touched? > `optional` **touched?**: `string` Defined in: [core/query/info.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L79) When the page was last touched (cache/link invalidation), not last edited. Existing pages only. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`touched`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#touched) *** ### transcludedin? > `optional` **transcludedin?**: [`ApiTranscludedIn`](https://types-mediawiki-response.pages.dev/api/core/ApiTranscludedIn.md)\[] Defined in: [core/query/transcludedin.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/transcludedin.ts#L28) Pages transcluding this page (`prop=transcludedin`). *** ### transcodestatus? > `optional` **transcodestatus?**: `unknown`\[] | `Record`\<`string`, [`ApiTranscodeState`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeState.md)> Defined in: [extensions/timedmediahandler.ts:170](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L170) Per-transcode job states, keyed by transcode key; `[]` — an empty array, not an empty object — when the file has no transcodes at all. *** ### varianttitles? > `optional` **varianttitles?**: `Record`\<`string`, `string`> Defined in: [core/query/info.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L243) Display titles per language variant, keyed by variant code (e.g. `zh-hans`). Also populated on wikis without language variants, where the single key is the content language itself. `inprop=varianttitles`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`varianttitles`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#varianttitles) *** ### videoinfo? > `optional` **videoinfo?**: [`ApiVideoInfo`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoInfo.md)\[] Defined in: [extensions/timedmediahandler.ts:164](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L164) File info extended with video sources and subtitle tracks. *** ### visitingwatchers? > `optional` **visitingwatchers?**: `number` Defined in: [core/query/info.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L116) Number of watchers who have visited the page since their notification timestamp. Same withholding rule as [watchers](#watchers). `inprop=visitingwatchers`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`visitingwatchers`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#visitingwatchers) *** ### watched? > `optional` **watched?**: `boolean` Defined in: [core/query/info.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L101) Whether the requesting user watches the page. A **real `boolean`** (`false` is returned), unlike most watch markers. `inprop=watched`; requires being logged in with the `viewmywatchlist` right. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`watched`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#watched) *** ### watchers? > `optional` **watchers?**: `number` Defined in: [core/query/info.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L109) Number of users watching the page. For callers without the `unwatchedpages` right the count is withheld entirely while it stays below `$wgUnwatchedPageThreshold`; `0` is only reported to callers with that right. `inprop=watchers`. #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`watchers`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#watchers) *** ### watchlistexpiry? > `optional` **watchlistexpiry?**: `string` Defined in: [core/query/info.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L123) When the requesting user's watch of this page expires. Requires `inprop=watched`; present only when the page is watched **with** an expiry (`action=watch&expiry=`). #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`watchlistexpiry`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#watchlistexpiry) *** ### watchlistlabels? > `optional` **watchlistlabels?**: [`ApiWatchlistLabel`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md)\[] Defined in: [core/query/info.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L133) Watchlist labels attached to this page by the requesting user. `inprop=watchlistlabels`; requires being logged in with the `viewmywatchlist` right (like [watched](#watched)) and `$wgEnableWatchlistLabels`, and is `[]` when the page has none. #### Since MediaWiki 1.46 #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`watchlistlabels`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#watchlistlabels) *** ### wbentityusage? > `optional` **wbentityusage?**: [`ApiEntityUsageMap`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageMap.md) Defined in: [extensions/wikibase.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L111) `prop=wbentityusage`: entities used by this page, keyed by entity id. *** ### wordcount? > `optional` **wordcount?**: `number` Defined in: [core/query/search.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L44) Word count. `srprop=wordcount`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`wordcount`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#wordcount) *** ### wouldautocreate? > `optional` **wouldautocreate?**: `unknown`\[] | `Record`\<`string`, `boolean`> Defined in: [core/query/info.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L151) Whether a temporary account would be auto-created for each tested action. `intestactionsautocreate=1` alongside `intestactions=`. A PHP map, so an empty result serializes as `[]`. #### Since MediaWiki 1.41 #### Inherited from [`ApiPageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md).[`wouldautocreate`](https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md#wouldautocreate) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageContributors.md --- > 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: ApiPageContributors Defined in: [core/query/contributors.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L24) Fields `prop=contributors` contributes to [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). [ContributorsPage](https://types-mediawiki-response.pages.dev/api/core/ContributorsPage.md) projects exactly this set. ## Extended by - [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) ## Properties ### anoncontributors? > `optional` **anoncontributors?**: `number` Defined in: [core/query/contributors.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L29) Number of anonymous (IP) contributors to the page (`prop=contributors`). *** ### contributors? > `optional` **contributors?**: [`ApiContributor`](https://types-mediawiki-response.pages.dev/api/core/ApiContributor.md)\[] Defined in: [core/query/contributors.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L26) Distinct logged-in contributors to the page (`prop=contributors`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageExisting.md --- > 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. # Type Alias: ApiPageExisting > **ApiPageExisting** = `Require`\<[`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md), `"pageid"` | `"ns"` | `"title"`> Defined in: [core/query/index.ts:442](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L442) A `query.pages` entry whose page exists. The framework resolves `pageid`, `ns` and `title` for every existing entry, so they are required here instead of optional as on the merged [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). The other entry states do not carry all three, which is why the merged [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) keeps them optional: a title-supplied `missing` entry has no `pageid`; a page-id-supplied `missing` entry has neither `ns` nor `title`; an `invalid` title has only `title`/`invalidreason`; a `special` entry has no `pageid`. Narrow to this type only when the request cannot yield those states — a `generator=` feed, or `pageids=` with known-good ids. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md --- > 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: ApiPageIdentity Defined in: [core/query/index.ts:359](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L359) Framework identity fields present on every `query.pages` entry, regardless of which `prop=` modules were requested. ## Extended by - [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) - [`ApiPurgeEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeEntry.md) - [`ApiImageRotateEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiImageRotateEntry.md) ## Properties ### invalid? > `optional` **invalid?**: `true` Defined in: [core/query/index.ts:384](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L384) `true` when the supplied title is not a valid title. *** ### invalidreason? > `optional` **invalidreason?**: `string` | [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) Defined in: [core/query/index.ts:390](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L390) Why the title is `invalid`: a plain string under the default (`bc`) `errorformat`, an [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one. *** ### known? > `optional` **known?**: `true` Defined in: [core/query/index.ts:381](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L381) `true` when the page does not exist but its content is known (e.g. a defined but unsaved interface message). Emitted by the framework itself, without requesting `prop=info`. *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/index.ts:374](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L374) `true` when the page does not exist. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/index.ts:368](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L368) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/index.ts:365](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L365) Page id. Absent when the id is unknown: a missing page requested by page id keeps its `pageid` alongside `missing`, while title-supplied missing/invalid pages and special pages carry no `pageid`. *** ### special? > `optional` **special?**: `true` Defined in: [core/query/index.ts:393](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L393) `true` for pages in a special namespace. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/index.ts:371](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L371) Full, normalized page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageImageInfo.md --- > 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: ApiPageImageInfo Defined in: [core/query/imageinfo.ts:251](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L251) Page-level fields `prop=imageinfo` contributes to [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). [ImageInfoPage](https://types-mediawiki-response.pages.dev/api/core/ImageInfoPage.md) projects exactly this set. ## Extended by - [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) ## Properties ### badfile? > `optional` **badfile?**: `boolean` Defined in: [core/query/imageinfo.ts:263](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L263) Whether the file is on the "bad images" list (`$wgBadImageList`). `iiprop=badfile` — a real `boolean`, and a **page-level sibling** of [ApiPage.imageinfo](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#imageinfo), not a member of the imageinfo entry. *** ### imageinfo? > `optional` **imageinfo?**: [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md)\[] Defined in: [core/query/imageinfo.ts:266](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L266) Image/file info entries (`prop=imageinfo`); usually one for the current file. *** ### imagerepository? > `optional` **imagerepository?**: `string` & `object` | `"local"` | `"shared"` Defined in: [core/query/imageinfo.ts:256](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L256) Where the file is hosted: the repository name, `local` for this wiki; `''` when the file does not exist. Framework field for file pages. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageInfo.md --- > 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: ApiPageInfo Defined in: [core/query/info.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L65) Fields `prop=info` contributes to [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md). [InfoPage](https://types-mediawiki-response.pages.dev/api/core/InfoPage.md) projects exactly this set. ## Extended by - [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) ## Properties ### actions? > `optional` **actions?**: `unknown`\[] | `Record`\<`string`, `boolean` | [`ApiActionPermission`](https://types-mediawiki-response.pages.dev/api/core/ApiActionPermission.md)\[]> Defined in: [core/query/info.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L142) Per-action permission test results, keyed by action name. Set by `intestactions=`: `intestactionsdetail=boolean` yields a `boolean` per action, while `full`/`quick` yields the array of blocking messages (empty when the action is allowed). A PHP map, so an empty result serializes as `[]`. *** ### associatedpage? > `optional` **associatedpage?**: `string` Defined in: [core/query/info.ts:218](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L218) Related page: the talk page for a subject, or vice versa. `inprop=associatedpage`; subject/talk namespaces only — not emitted on special or `Media:` pages. *** ### canonicalurl? > `optional` **canonicalurl?**: `string` Defined in: [core/query/info.ts:233](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L233) Canonical URL. `inprop=url`. *** ### contentmodel? > `optional` **contentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/info.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L67) Content model of the page's current revision. *** ### displaytitle? > `optional` **displaytitle?**: `string` Defined in: [core/query/info.ts:236](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L236) HTML title used for display. `inprop=displaytitle`. *** ### editintro? > `optional` **editintro?**: `Record`\<`string`, `string`> Defined in: [core/query/info.ts:205](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L205) Notices the edit form should show, keyed by message name (e.g. `newarticletext`) with HTML values. Drawn from the whole edit-form intro message set — `newarticletext`, `talkpagetext`, per-namespace editnotices, `Editintro` pages, … — not only `MediaWiki:Editintro*` pages. `inprop=editintro`; only for a single title per query. #### Since MediaWiki 1.41 *** ### editurl? > `optional` **editurl?**: `string` Defined in: [core/query/info.ts:230](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L230) Edit-page URL. `inprop=url`. *** ### fullurl? > `optional` **fullurl?**: `string` Defined in: [core/query/info.ts:227](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L227) Fully-resolved canonical article URL. `inprop=url`. *** ### lastrevid? > `optional` **lastrevid?**: `number` Defined in: [core/query/info.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L82) Revision id of the latest revision. Existing pages only. *** ### length? > `optional` **length?**: `number` Defined in: [core/query/info.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L85) Length of the page content in bytes. Existing pages only. *** ### linkclasses? > `optional` **linkclasses?**: `string`\[] Defined in: [core/query/info.ts:250](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L250) CSS classes to apply to links to this page (core marks redirects `mw-redirect`; extensions may add more). `inprop=linkclasses`; emitted for every requested page, `[]` when there is no class for it. *** ### new? > `optional` **new?**: `true` Defined in: [core/query/info.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L94) `true` when the page is in the new-pages list (no other page links to it and it has a single revision). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) — absent for established pages. *** ### notificationtimestamp? > `optional` **notificationtimestamp?**: `string` Defined in: [core/query/info.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L158) When the requesting user last saw the page. An **empty string** when never visited (or when notifications are off), otherwise a timestamp. `inprop=notificationtimestamp`. *** ### pagelanguage? > `optional` **pagelanguage?**: `string` Defined in: [core/query/info.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L70) Page language code, e.g. `en`. *** ### pagelanguagedir? > `optional` **pagelanguagedir?**: `"ltr"` | `"rtl"` Defined in: [core/query/info.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L76) Writing direction of the page language. *** ### pagelanguagehtmlcode? > `optional` **pagelanguagehtmlcode?**: `string` Defined in: [core/query/info.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L73) HTML `lang` attribute value for the page language. *** ### ~~preload?~~ > `optional` **preload?**: `string` Defined in: [core/query/info.ts:176](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L176) Text pre-filled into the edit box for a missing page, from the `EditFormPreloadText` hook. `''` when the page exists. `inprop=preload`. #### Deprecated since MediaWiki 1.41 in favour of [preloadcontent](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#preloadcontent), which also reports the content model and format. *** ### preloadcontent? > `optional` **preloadcontent?**: [`ApiPreloadedContent`](https://types-mediawiki-response.pages.dev/api/core/ApiPreloadedContent.md) Defined in: [core/query/info.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L186) Content the edit form would preload: for a page that does not exist yet, or for an existing page when a new section would be added (`preloadnewsection=1`). `inprop=preloadcontent`; only for a single title/revision per query. #### Since MediaWiki 1.41 *** ### preloadisdefault? > `optional` **preloadisdefault?**: `boolean` Defined in: [core/query/info.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L194) Whether [preloadcontent](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#preloadcontent) is identical to the page's default content, in which case saving it would be a no-op. `inprop=preloadcontent`. #### Since MediaWiki 1.41 *** ### protection? > `optional` **protection?**: [`ApiPageProtection`](https://types-mediawiki-response.pages.dev/api/core/ApiPageProtection.md)\[] Defined in: [core/query/info.ts:208](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L208) Protection entries; empty array when unrestricted. `inprop=protection`. *** ### ~~readable?~~ > `optional` **readable?**: `boolean` Defined in: [core/query/info.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L166) Whether the current user may read the page. A real `boolean` (`false` included). `inprop=readable`. #### Deprecated since MediaWiki 1.32; use `intestactions=read` instead. *** ### redirect? > `optional` **redirect?**: `true` Defined in: [core/query/info.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L88) `true` when the page is a redirect. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) (appears only when true). *** ### restrictiontypes? > `optional` **restrictiontypes?**: `string`\[] Defined in: [core/query/info.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L211) Restriction types that apply, e.g. `edit`, `move`, `create`. `inprop=protection`. *** ### subjectid? > `optional` **subjectid?**: `number` Defined in: [core/query/info.ts:224](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L224) Page id of the associated subject page. `inprop=subjectid` (talk pages only). *** ### talkid? > `optional` **talkid?**: `number` Defined in: [core/query/info.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L221) Page id of the associated talk page. `inprop=talkid` (subject pages only). *** ### touched? > `optional` **touched?**: `string` Defined in: [core/query/info.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L79) When the page was last touched (cache/link invalidation), not last edited. Existing pages only. *** ### varianttitles? > `optional` **varianttitles?**: `Record`\<`string`, `string`> Defined in: [core/query/info.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L243) Display titles per language variant, keyed by variant code (e.g. `zh-hans`). Also populated on wikis without language variants, where the single key is the content language itself. `inprop=varianttitles`. *** ### visitingwatchers? > `optional` **visitingwatchers?**: `number` Defined in: [core/query/info.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L116) Number of watchers who have visited the page since their notification timestamp. Same withholding rule as [watchers](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#watchers). `inprop=visitingwatchers`. *** ### watched? > `optional` **watched?**: `boolean` Defined in: [core/query/info.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L101) Whether the requesting user watches the page. A **real `boolean`** (`false` is returned), unlike most watch markers. `inprop=watched`; requires being logged in with the `viewmywatchlist` right. *** ### watchers? > `optional` **watchers?**: `number` Defined in: [core/query/info.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L109) Number of users watching the page. For callers without the `unwatchedpages` right the count is withheld entirely while it stays below `$wgUnwatchedPageThreshold`; `0` is only reported to callers with that right. `inprop=watchers`. *** ### watchlistexpiry? > `optional` **watchlistexpiry?**: `string` Defined in: [core/query/info.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L123) When the requesting user's watch of this page expires. Requires `inprop=watched`; present only when the page is watched **with** an expiry (`action=watch&expiry=`). *** ### watchlistlabels? > `optional` **watchlistlabels?**: [`ApiWatchlistLabel`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md)\[] Defined in: [core/query/info.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L133) Watchlist labels attached to this page by the requesting user. `inprop=watchlistlabels`; requires being logged in with the `viewmywatchlist` right (like [watched](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#watched)) and `$wgEnableWatchlistLabels`, and is `[]` when the page has none. #### Since MediaWiki 1.46 *** ### wouldautocreate? > `optional` **wouldautocreate?**: `unknown`\[] | `Record`\<`string`, `boolean`> Defined in: [core/query/info.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L151) Whether a temporary account would be auto-created for each tested action. `intestactionsautocreate=1` alongside `intestactions=`. A PHP map, so an empty result serializes as `[]`. #### Since MediaWiki 1.41 --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageLink.md --- > 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: ApiPageLink Defined in: [core/query/links.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/links.ts#L12) One link made by a page. ## Properties ### ns > **ns**: `number` Defined in: [core/query/links.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/links.ts#L14) Namespace index. *** ### title > **title**: `string` Defined in: [core/query/links.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/links.ts#L17) Linked page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPagePropName.md --- > 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: ApiPagePropName Defined in: [core/query/pagepropnames.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pagepropnames.ts#L10) One page property name in use. ## Properties ### propname > **propname**: `string` Defined in: [core/query/pagepropnames.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pagepropnames.ts#L12) Property name as stored in `page_props`, e.g. `displaytitle`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageProps.md --- > 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. # Type Alias: ApiPageProps > **ApiPageProps** = `Record`\<`string`, `string`> Defined in: [core/query/pageprops.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageprops.ts#L14) The set of known property values is open-ended and site/extension-specific. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageProtection.md --- > 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: ApiPageProtection Defined in: [core/query/info.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L13) One entry of a page's `protection` array (`inprop=protection`). ## Properties ### cascade? > `optional` **cascade?**: `true` Defined in: [core/query/info.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L27) Whether this restriction cascades to transcluded pages. Appears only when the page has `cascade=true` set (see `action=protect`), and is a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### expiry > **expiry**: `string` Defined in: [core/query/info.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L21) Expiry, or `infinity` / `infinite` when permanent. *** ### level > **level**: `string` Defined in: [core/query/info.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L18) Required right/group level, e.g. `sysop` / `autoconfirmed`. Empty when unrestricted. *** ### source? > `optional` **source?**: `string` Defined in: [core/query/info.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L34) Title of the page whose protection cascades onto this one. Present only on entries inherited through cascading protection, i.e. never together with [cascade](#cascade) on the same entry. *** ### type > **type**: `string` Defined in: [core/query/info.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L15) Restriction kind, e.g. `edit` / `move`. Open union. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md --- > 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: ApiPageRef Defined in: [core/query/shared.ts:7](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L7) The `pageid`/`ns`/`title` page identity triple shared by `list=` module rows. ## Extended by - [`ApiUnreviewedPage`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiUnreviewedPage.md) - [`ApiOldReviewedPage`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiOldReviewedPage.md) - [`ApiConfiguredPage`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiConfiguredPage.md) - [`ApiLintError`](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintError.md) - [`ApiAllPage`](https://types-mediawiki-response.pages.dev/api/core/ApiAllPage.md) - [`ApiBacklink`](https://types-mediawiki-response.pages.dev/api/core/ApiBacklink.md) - [`ApiEmbeddedIn`](https://types-mediawiki-response.pages.dev/api/core/ApiEmbeddedIn.md) - [`ApiImageUsage`](https://types-mediawiki-response.pages.dev/api/core/ApiImageUsage.md) - [`ApiIwbacklink`](https://types-mediawiki-response.pages.dev/api/core/ApiIwbacklink.md) - [`ApiLangbacklink`](https://types-mediawiki-response.pages.dev/api/core/ApiLangbacklink.md) - [`ApiAllDeletedRevisions`](https://types-mediawiki-response.pages.dev/api/core/ApiAllDeletedRevisions.md) - [`ApiAllRevisions`](https://types-mediawiki-response.pages.dev/api/core/ApiAllRevisions.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPagesWithProp.md --- > 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: ApiPagesWithProp Defined in: [core/query/pageswithprop.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageswithprop.ts#L11) One page that defines the requested property. ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [core/query/pageswithprop.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageswithprop.ts#L16) Namespace index. `pwpprop=title` (default). *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/pageswithprop.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageswithprop.ts#L13) Page id. `pwpprop=ids`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/pageswithprop.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageswithprop.ts#L19) Full page title. *** ### value? > `optional` **value?**: `string` Defined in: [core/query/pageswithprop.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageswithprop.ts#L25) Property value. `pwpprop=value` — a string, empty for switch-like properties (`__DISAMBIG__`), same as `prop=pageprops`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParse.md --- > 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: ApiParse Defined in: [core/parse.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L221) The `parse` object of a successful `action=parse` response. `title` and `pageid` are written before any `prop` value is considered; with `onlypst=1` the module returns a different, metadata-free shape instead — see [ApiParseOnlyPstResponse](https://types-mediawiki-response.pages.dev/api/core/ApiParseOnlyPstResponse.md). ## Properties ### categories? > `optional` **categories?**: [`ApiParseCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiParseCategory.md)\[] Defined in: [core/parse.ts:265](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L265) Categories the page would be added to. `prop=categories`. *** ### categorieshtml? > `optional` **categorieshtml?**: `string` Defined in: [core/parse.ts:289](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L289) HTML for the categories, keyed like [categories](#categories). `prop=categorieshtml`. *** ### displaytitle? > `optional` **displaytitle?**: `string` Defined in: [core/parse.ts:262](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L262) HTML for the display title. `prop=displaytitle`. *** ### encodedjsconfigvars? > `optional` **encodedjsconfigvars?**: `string` Defined in: [core/parse.ts:333](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L333) [jsconfigvars](#jsconfigvars) as a JSON string, ready to inline. `prop=encodedjsconfigvars`. *** ### externallinks? > `optional` **externallinks?**: `string`\[] Defined in: [core/parse.ts:277](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L277) External URLs linked by the content. `prop=externallinks`. *** ### headhtml? > `optional` **headhtml?**: `string` Defined in: [core/parse.ts:377](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L377) Full HTML document head. `prop=headhtml`. *** ### ~~headitems?~~ > `optional` **headitems?**: [`ApiParseHeadItem`](https://types-mediawiki-response.pages.dev/api/core/ApiParseHeadItem.md)\[] Defined in: [core/parse.ts:366](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L366) Raw `` elements, one `{tag, content}` entry each. `prop=headitems`. #### Deprecated since MediaWiki 1.28 — use [headhtml](#headhtml) to build a document, or [modules](#modules) + `jsconfigvars` to update one client-side. *** ### images? > `optional` **images?**: `string`\[] Defined in: [core/parse.ts:274](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L274) File names used by the content. `prop=images`. *** ### indicators? > `optional` **indicators?**: `Record`\<`string`, `string`> Defined in: [core/parse.ts:295](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L295) HTML page-indicator hooks. `prop=indicators`. *** ### iwlinks? > `optional` **iwlinks?**: [`ApiParseIWLink`](https://types-mediawiki-response.pages.dev/api/core/ApiParseIWLink.md)\[] Defined in: [core/parse.ts:283](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L283) Interwiki links. `prop=iwlinks`. *** ### jsconfigvars? > `optional` **jsconfigvars?**: `Record`\<`string`, `unknown`> Defined in: [core/parse.ts:328](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L328) `window.mw.config` values needed by [modules](#modules), keyed by variable name. `prop=jsconfigvars`. *** ### langlinks? > `optional` **langlinks?**: [`ApiParseLangLink`](https://types-mediawiki-response.pages.dev/api/core/ApiParseLangLink.md)\[] Defined in: [core/parse.ts:280](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L280) Interlanguage links. `prop=langlinks`. *** ### limitreportdata? > `optional` **limitreportdata?**: [`ApiParseLimitReportEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiParseLimitReportEntry.md)\[] Defined in: [core/parse.ts:352](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L352) Parser profiling rows. `prop=limitreportdata` — emitted regardless of `disablelimitreport` (that only strips the table from the rendered text). *** ### limitreporthtml? > `optional` **limitreporthtml?**: `string` Defined in: [core/parse.ts:358](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L358) Parser profiling rendered as a preview HTML table. `prop=limitreporthtml`. Its numbers change on every request. *** ### links? > `optional` **links?**: [`ApiParseLink`](https://types-mediawiki-response.pages.dev/api/core/ApiParseLink.md)\[] Defined in: [core/parse.ts:268](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L268) Pages linked from the content. `prop=links`. *** ### modules? > `optional` **modules?**: `string`\[] Defined in: [core/parse.ts:309](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L309) ResourceLoader modules required by the output. `prop=modules` (also emits [modulescripts](#modulescripts) and [modulestyles](#modulestyles)); must be paired with `jsconfigvars`/`encodedjsconfigvars` or the API warns. *** ### ~~modulescripts?~~ > `optional` **modulescripts?**: `never`\[] Defined in: [core/parse.ts:316](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L316) The script-bearing subset of [modules](#modules). #### Deprecated since MediaWiki 1.32 — always empty; read [modules](#modules) instead. *** ### modulestyles? > `optional` **modulestyles?**: `string`\[] Defined in: [core/parse.ts:322](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L322) The style-bearing subset of [modules](#modules). `prop=modules` — a plain module-name list. *** ### pageid > **pageid**: `number` Defined in: [core/parse.ts:229](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L229) Page id of the context title — the parsed page, or the `title` parameter (default `API`) when parsing text. `0` only when that title does not exist. *** ### parsedsummary? > `optional` **parsedsummary?**: `string` Defined in: [core/parse.ts:259](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L259) Parsed edit summary (`summary=` given, or `sectiontitle=` with `section=new`). *** ### parsetree? > `optional` **parsetree?**: `string` Defined in: [core/parse.ts:374](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L374) The preprocessor result as an XML tree. `prop=parsetree`; requires a wikitext content model (otherwise the call fails with the `notwikitext` error code). Not flagged deprecated by 1.43, unlike the `generatexml` parameter that also produces it. *** ### parsewarnings? > `optional` **parsewarnings?**: `string`\[] Defined in: [core/parse.ts:298](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L298) Parser warnings for the input. `prop=parsewarnings`. *** ### parsewarningshtml? > `optional` **parsewarningshtml?**: `string`\[] Defined in: [core/parse.ts:346](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L346) HTML list of parser warnings. `prop=parsewarningshtml`. *** ### properties? > `optional` **properties?**: `Record`\<`string`, `unknown`> Defined in: [core/parse.ts:304](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L304) Extension-registered display properties (values are numbers, strings, or arrays). `prop=properties`; the set is open-ended. *** ### psttext? > `optional` **psttext?**: `string` Defined in: [core/parse.ts:256](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L256) Pre-save-transformed wikitext (`prop=wikitext` + `pst=1`). *** ### redirects? > `optional` **redirects?**: [`ApiParseRedirect`](https://types-mediawiki-response.pages.dev/api/core/ApiParseRedirect.md)\[] Defined in: [core/parse.ts:244](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L244) Redirect resolutions (with `redirects=1`). *** ### revid? > `optional` **revid?**: `number` Defined in: [core/parse.ts:241](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L241) Revision id the content was parsed from. Emitted whenever `oldid` was given, or when parsing a page with `prop=revid`. *** ### sections? > `optional` **sections?**: [`ApiParseSection`](https://types-mediawiki-response.pages.dev/api/core/ApiParseSection.md)\[] Defined in: [core/parse.ts:286](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L286) Section outline. `prop=sections`. *** ### showtoc? > `optional` **showtoc?**: `boolean` Defined in: [core/parse.ts:343](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L343) Whether the output should show a TOC. `prop=tocdata` or `prop=sections`; a real `boolean`. *** ### subtitle? > `optional` **subtitle?**: `string` Defined in: [core/parse.ts:292](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L292) Page subtitle. `prop=subtitle`. *** ### templates? > `optional` **templates?**: [`ApiParseLink`](https://types-mediawiki-response.pages.dev/api/core/ApiParseLink.md)\[] Defined in: [core/parse.ts:271](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L271) Pages transcluded by the content. `prop=templates`. *** ### text? > `optional` **text?**: `string` Defined in: [core/parse.ts:250](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L250) Rendered HTML output (`formatversion=2`: a plain string). `prop=text`. With `onlypst=1`, the pre-save-transformed wikitext instead. *** ### textdeleted? > `optional` **textdeleted?**: `true` Defined in: [core/parse.ts:232](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L232) The revision's text was deleted. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### textsuppressed? > `optional` **textsuppressed?**: `true` Defined in: [core/parse.ts:235](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L235) The revision's text was suppressed. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### title > **title**: `string` Defined in: [core/parse.ts:223](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L223) Page title the content was parsed as. *** ### tocdata? > `optional` **tocdata?**: [`ApiParseTocData`](https://types-mediawiki-response.pages.dev/api/core/ApiParseTocData.md) Defined in: [core/parse.ts:340](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L340) Table of contents with camelCased entries. `prop=tocdata`. #### Since MediaWiki 1.43 *** ### wikitext? > `optional` **wikitext?**: `string` Defined in: [core/parse.ts:253](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L253) Source wikitext. `prop=wikitext`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseCategory.md --- > 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: ApiParseCategory Defined in: [core/parse.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L15) A category the parsed page would add itself to (`prop=categories`). ## Properties ### category > **category**: `string` Defined in: [core/parse.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L23) Category name, without the `Category:` prefix. *** ### hidden? > `optional` **hidden?**: `true` Defined in: [core/parse.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L26) Whether the category is hidden. `prop=categories`. *** ### known? > `optional` **known?**: `true` Defined in: [core/parse.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L32) A `missing` category that is nonetheless "known" (a redlinked category). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### missing? > `optional` **missing?**: `true` Defined in: [core/parse.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L29) Whether the category page is missing. `prop=categories`. *** ### sortkey > **sortkey**: `string` Defined in: [core/parse.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L20) Sort key text — the piped sortkey or `{{DEFAULTSORT:…}}` value; `''` when the default applies. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseHeadItem.md --- > 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: ApiParseHeadItem~~ Defined in: [core/parse.ts:207](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L207) One raw `` element (`prop=headitems`). ## Deprecated since MediaWiki 1.28; see [ApiParse.headitems](https://types-mediawiki-response.pages.dev/api/core/ApiParse.md#headitems). ## Properties ### ~~content~~ > **content**: `string` Defined in: [core/parse.ts:212](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L212) Markup of the head item. *** ### ~~tag~~ > **tag**: `string` Defined in: [core/parse.ts:209](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L209) Element name the item was collected under (often a numeric key). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseIWLink.md --- > 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: ApiParseIWLink Defined in: [core/parse.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L72) An interwiki link (`prop=iwlinks`). ## Properties ### prefix > **prefix**: `string` Defined in: [core/parse.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L74) Interwiki prefix. *** ### title > **title**: `string` Defined in: [core/parse.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L80) Target page title. *** ### url? > `optional` **url?**: `string` Defined in: [core/parse.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L77) Full URL of the target page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseLangLink.md --- > 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: ApiParseLangLink Defined in: [core/parse.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L48) An interlanguage link (`prop=langlinks`). ## Properties ### autonym? > `optional` **autonym?**: `string` Defined in: [core/parse.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L65) Native language name. Present when the target title is valid (`action=parse` has no `llprop` parameter). *** ### lang > **lang**: `string` Defined in: [core/parse.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L50) Language code. *** ### langname? > `optional` **langname?**: `string` Defined in: [core/parse.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L59) Localized language name, in the request `uselang` language. Present when the target title is valid (`action=parse` has no `llprop` parameter). *** ### title > **title**: `string` Defined in: [core/parse.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L68) Target page title. *** ### url? > `optional` **url?**: `string` Defined in: [core/parse.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L53) Full URL of the target page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseLimitReportEntry.md --- > 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: ApiParseLimitReportEntry Defined in: [core/parse.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L191) One row of `limitreportdata` (`prop=limitreportdata`). fv2 keeps the PHP array's numeric keys, so the measurement(s) sit under `"0"`/`"1"`. ## Indexable > \[`value`: `string`]: `string` | `number` | `boolean` | `undefined` `"0"` is the measured value; `"1"` is the configured limit for used/limit pairs. Values are strings, numbers, or booleans depending on the row. ## Properties ### name? > `optional` **name?**: `string` Defined in: [core/parse.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L193) Report key, e.g. `limitreport-cputime` or `cachereport-ttl`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseLink.md --- > 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: ApiParseLink Defined in: [core/parse.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L36) A wikilink or template used by the parsed page (`prop=links` / `prop=templates`). ## Properties ### exists > **exists**: `boolean` Defined in: [core/parse.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L44) Whether the target page exists; an explicit `false` for redlinks. *** ### ns > **ns**: `number` Defined in: [core/parse.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L38) Namespace index. *** ### title > **title**: `string` Defined in: [core/parse.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L41) Target page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseOnlyPstResponse.md --- > 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: ApiParseOnlyPstResponse Defined in: [core/parse.ts:391](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L391) Response of `action=parse&onlypst=1`: the module builds the payload before it resolves a title, so only the pre-save-transformed text comes back — no `title`/`pageid` and none of the `prop` sub-objects of [ApiParse](https://types-mediawiki-response.pages.dev/api/core/ApiParse.md). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### parse > **parse**: `object` Defined in: [core/parse.ts:393](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L393) Result of `action=parse&onlypst=1`. #### parsedsummary? > `optional` **parsedsummary?**: `string` Parsed edit summary (`summary=`, or `sectiontitle=` with `section=new`). #### text > **text**: `string` Pre-save-transformed wikitext. #### wikitext? > `optional` **wikitext?**: `string` Source wikitext (`prop=wikitext`). *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseRedirect.md --- > 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: ApiParseRedirect Defined in: [core/parse.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L84) One redirect resolution (with `redirects=1`, when parsing `page=`/`pageid=`). ## Properties ### from? > `optional` **from?**: `string` Defined in: [core/parse.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L86) Redirect source title. *** ### to? > `optional` **to?**: `string` Defined in: [core/parse.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L89) Title the redirect points to. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseResponse.md --- > 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: ApiParseResponse Defined in: [core/parse.ts:381](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L381) Response of `action=parse`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### parse > **parse**: [`ApiParse`](https://types-mediawiki-response.pages.dev/api/core/ApiParse.md) Defined in: [core/parse.ts:383](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L383) Result of `action=parse`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseSection.md --- > 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: ApiParseSection Defined in: [core/parse.ts:98](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L98) A table-of-contents entry (`prop=sections`) — the legacy projection of the same outline `prop=tocdata` emits, with lowercase keys here (`fromtitle`, `byteoffset`) against camelCase there (`fromTitle`, `codepointOffset`); see [ApiParseTocSection](https://types-mediawiki-response.pages.dev/api/core/ApiParseTocSection.md). `extensionData` appears only when non-empty. ## Properties ### anchor > **anchor**: `string` Defined in: [core/parse.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L128) Anchor name for links. *** ### byteoffset > **byteoffset**: `number` | `null` Defined in: [core/parse.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L125) Offset of the heading in the source, in **code points** despite the legacy name; `null` for a heading that is not a "preprocessor section" (e.g. one written as a literal `` tag). *** ### extensionData? > `optional` **extensionData?**: `unknown`\[] | `Record`\<`string`, `unknown`> Defined in: [core/parse.ts:138](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L138) Extension-supplied data for this section; only when non-empty. *** ### fromtitle > **fromtitle**: `string` | `false` Defined in: [core/parse.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L118) Title the section came from; `false` when it has none — the legacy serialization of a null title, where `prop=tocdata` omits the key instead. *** ### index > **index**: `string` Defined in: [core/parse.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L112) `edit` parameter value for this section. *** ### level > **level**: `string` Defined in: [core/parse.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L103) Heading level, as a string (`"1"` for `= … =`). *** ### line > **line**: `string` Defined in: [core/parse.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L106) Heading text (HTML). *** ### linkAnchor? > `optional` **linkAnchor?**: `string` Defined in: [core/parse.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L135) Anchor used by the section's own edit link. #### Since MediaWiki 1.40 *** ### number > **number**: `string` Defined in: [core/parse.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L109) Section number in the outline, e.g. `1.1`. *** ### toclevel > **toclevel**: `number` Defined in: [core/parse.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L100) Nesting level in the TOC. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseTocData.md --- > 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: ApiParseTocData Defined in: [core/parse.ts:179](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L179) The `tocdata` object (`prop=tocdata`). ## Properties ### extensionData > **extensionData**: `unknown`\[] | `Record`\<`string`, `unknown`> Defined in: [core/parse.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L184) Extension-supplied TOC data, keyed by extension; `[]` when empty. *** ### sections > **sections**: [`ApiParseTocSection`](https://types-mediawiki-response.pages.dev/api/core/ApiParseTocSection.md)\[] Defined in: [core/parse.ts:181](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L181) The outline, in camelCase keys. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiParseTocSection.md --- > 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: ApiParseTocSection Defined in: [core/parse.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L146) One `tocdata` section (`prop=tocdata`) — the same outline as [ApiParseSection](https://types-mediawiki-response.pages.dev/api/core/ApiParseSection.md) but camelCased, with an HTML heading level instead of a wikitext `level` and a code-point offset instead of a byte offset. ## Properties ### anchor? > `optional` **anchor?**: `string` Defined in: [core/parse.ts:169](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L169) Anchor name for links. *** ### codepointOffset? > `optional` **codepointOffset?**: `number` Defined in: [core/parse.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L166) Offset of the heading in code points, not bytes. *** ### extensionData? > `optional` **extensionData?**: `unknown`\[] | `Record`\<`string`, `unknown`> Defined in: [core/parse.ts:175](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L175) Extension-supplied data for this section; `[]` when empty. *** ### fromTitle? > `optional` **fromTitle?**: `string` Defined in: [core/parse.ts:163](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L163) Title the section came from. *** ### hLevel? > `optional` **hLevel?**: `number` Defined in: [core/parse.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L151) HTML heading level, as a number (1 for `

`, 2 for `

`, …). *** ### index? > `optional` **index?**: `string` Defined in: [core/parse.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L160) `edit` parameter value for this section. *** ### line? > `optional` **line?**: `string` Defined in: [core/parse.ts:154](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L154) Heading text (HTML). *** ### linkAnchor? > `optional` **linkAnchor?**: `string` Defined in: [core/parse.ts:172](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L172) Anchor used by the section's own edit link (leading `#` included). *** ### number? > `optional` **number?**: `string` Defined in: [core/parse.ts:157](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L157) Section number in the outline, e.g. `1.1`. *** ### tocLevel? > `optional` **tocLevel?**: `number` Defined in: [core/parse.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/parse.ts#L148) Nesting level in the TOC. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPasswordValidity.md --- > 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. # Type Alias: ApiPasswordValidity > **ApiPasswordValidity** = `"Good"` | `"Change"` | `"Invalid"` | `string` & `object` Defined in: [core/validatepassword.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/validatepassword.ts#L20) Password-policy verdict mapped from `checkPasswordValidity`'s Status. Open union. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResponse.md --- > 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: ApiPatrolResponse Defined in: [core/patrol.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/patrol.ts#L23) Response of `action=patrol`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### patrol > **patrol**: [`ApiPatrolResult`](https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResult.md) Defined in: [core/patrol.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/patrol.ts#L25) Result of `action=patrol`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPatrolResult.md --- > 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: ApiPatrolResult Defined in: [core/patrol.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/patrol.ts#L11) The `patrol` object of a successful `action=patrol` response. ## Properties ### ns > **ns**: `number` Defined in: [core/patrol.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/patrol.ts#L16) Namespace of the patrolled page. *** ### rcid > **rcid**: `number` Defined in: [core/patrol.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/patrol.ts#L13) Recent-changes id that was patrolled. *** ### title > **title**: `string` Defined in: [core/patrol.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/patrol.ts#L19) Title of the patrolled page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPrefixSearchResult.md --- > 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: ApiPrefixSearchResult Defined in: [core/query/prefixsearch.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/prefixsearch.ts#L13) One prefix-search hit. ## Properties ### ns > **ns**: `number` Defined in: [core/query/prefixsearch.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/prefixsearch.ts#L21) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/prefixsearch.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/prefixsearch.ts#L15) Page id. Absent on a [special](#special) hit, which takes its place. *** ### special? > `optional` **special?**: `true` Defined in: [core/query/prefixsearch.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/prefixsearch.ts#L18) The hit is a special page; takes the place of `pageid`. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### title > **title**: `string` Defined in: [core/query/prefixsearch.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/prefixsearch.ts#L24) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPreloadedContent.md --- > 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: ApiPreloadedContent Defined in: [core/query/info.ts:271](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L271) Preloaded edit content (`inprop=preloadcontent`), which fills the main slot. ## Properties ### content? > `optional` **content?**: `string` Defined in: [core/query/info.ts:279](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L279) The preloaded body; `''` when nothing is configured for the title. *** ### contentformat? > `optional` **contentformat?**: [`ContentFormat`](https://types-mediawiki-response.pages.dev/api/core/ContentFormat.md) Defined in: [core/query/info.ts:276](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L276) Serialization format, e.g. `text/x-wiki`. *** ### contentmodel? > `optional` **contentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/info.ts:273](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L273) Content model of the preloaded text, e.g. `wikitext`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiProtectResponse.md --- > 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: ApiProtectResponse Defined in: [core/protect.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L52) Response of `action=protect`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### protect > **protect**: [`ApiProtectResult`](https://types-mediawiki-response.pages.dev/api/core/ApiProtectResult.md) Defined in: [core/protect.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L54) Result of `action=protect`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiProtectResult.md --- > 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: ApiProtectResult Defined in: [core/protect.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L37) The `protect` object of an `action=protect` response. ## Properties ### cascade? > `optional` **cascade?**: `true` Defined in: [core/protect.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L45) The protection cascades to the pages transcluded here (`cascade=1`). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### protections > **protections**: [`ApiProtectionEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiProtectionEntry.md)\[] Defined in: [core/protect.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L48) Applied restrictions, one entry per restriction type. *** ### reason > **reason**: `string` Defined in: [core/protect.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L42) Protection reason (echoed back). *** ### title > **title**: `string` Defined in: [core/protect.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L39) Protected page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiProtectedTitle.md --- > 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: ApiProtectedTitle Defined in: [core/query/protectedtitles.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L17) One protected title. `ptprop` controls which fields appear. ## Properties ### comment? > `optional` **comment?**: `string` Defined in: [core/query/protectedtitles.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L40) Raw protection reason. `ptprop=comment`. *** ### expiry? > `optional` **expiry?**: `string` Defined in: [core/query/protectedtitles.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L46) When the protection lapses, or `infinity`. `ptprop=expiry`. *** ### level? > `optional` **level?**: [`ProtectedTitleLevel`](https://types-mediawiki-response.pages.dev/api/core/ProtectedTitleLevel.md) Defined in: [core/query/protectedtitles.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L25) Restriction level applied, e.g. `sysop`. `ptprop=level`. *** ### ns > **ns**: `number` Defined in: [core/query/protectedtitles.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L19) Namespace index. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/protectedtitles.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L43) HTML-rendered protection reason. `ptprop=parsedcomment`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/protectedtitles.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L28) When the protection was applied. `ptprop=timestamp`. *** ### title > **title**: `string` Defined in: [core/query/protectedtitles.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L22) The protected (non-existent) title. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/protectedtitles.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L31) Name of the protecting user. `ptprop=user`. *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/protectedtitles.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L37) Id of the protecting user. `ptprop=userid`; also emitted with `ptprop=user` (B/C). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiProtectionEntry.md --- > 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: ApiProtectionEntry Defined in: [core/protect.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L16) One applied protection (`type` → level, plus `expiry`). ## Indexable > \[`type`: `string`]: `string` | `undefined` Extension-provided restriction types are carried through as string levels. ## Properties ### create? > `optional` **create?**: `string` Defined in: [core/protect.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L24) Create-protection level, when the `create` restriction is set. *** ### edit? > `optional` **edit?**: `string` Defined in: [core/protect.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L18) Edit-protection level (right/group name), when the `edit` restriction is set. *** ### expiry > **expiry**: `string` Defined in: [core/protect.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L30) Expiry for this restriction, or `infinite`. *** ### move? > `optional` **move?**: `string` Defined in: [core/protect.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L21) Move-protection level, when the `move` restriction is set. *** ### upload? > `optional` **upload?**: `string` Defined in: [core/protect.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/protect.ts#L27) Upload-protection level, when the `upload` restriction is set. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPurgeEntry.md --- > 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: ApiPurgeEntry Defined in: [core/purge.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L14) One purged page. ## Extends - [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md) ## Properties ### invalid? > `optional` **invalid?**: `true` Defined in: [core/query/index.ts:384](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L384) `true` when the supplied title is not a valid title. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`invalid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#invalid) *** ### invalidreason? > `optional` **invalidreason?**: `string` | [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) Defined in: [core/query/index.ts:390](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L390) Why the title is `invalid`: a plain string under the default (`bc`) `errorformat`, an [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`invalidreason`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#invalidreason) *** ### iw? > `optional` **iw?**: `string` Defined in: [core/purge.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L28) Interwiki prefix, for entries describing an interwiki title. *** ### known? > `optional` **known?**: `true` Defined in: [core/query/index.ts:381](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L381) `true` when the page does not exist but its content is known (e.g. a defined but unsaved interface message). Emitted by the framework itself, without requesting `prop=info`. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`known`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#known) *** ### linkupdate? > `optional` **linkupdate?**: `true` Defined in: [core/purge.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L22) Whether a link table update was queued (with `forcelinkupdate` or `forcerecursivelinkupdate`). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/index.ts:374](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L374) `true` when the page does not exist. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`missing`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#missing) *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/index.ts:368](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L368) Namespace index. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#ns) *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/index.ts:365](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L365) Page id. Absent when the id is unknown: a missing page requested by page id keeps its `pageid` alongside `missing`, while title-supplied missing/invalid pages and special pages carry no `pageid`. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#pageid) *** ### purged? > `optional` **purged?**: `true` Defined in: [core/purge.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L16) Whether the page was actually purged. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) (appears when purged). *** ### revid? > `optional` **revid?**: `number` Defined in: [core/purge.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L25) Revision id, for entries describing a `revids=` value that did not resolve. *** ### special? > `optional` **special?**: `true` Defined in: [core/query/index.ts:393](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L393) `true` for pages in a special namespace. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`special`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#special) *** ### title? > `optional` **title?**: `string` Defined in: [core/query/index.ts:371](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L371) Full, normalized page title. #### Inherited from [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md#title) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiPurgeResponse.md --- > 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: ApiPurgeResponse Defined in: [core/purge.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L32) Response of `action=purge`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### converted? > `optional` **converted?**: [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md)\[] Defined in: [core/purge.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L43) Title conversions on a language-variant wiki, same shape as `query.converted`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### normalized? > `optional` **normalized?**: [`ApiQueryNormalized`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryNormalized.md)\[] Defined in: [core/purge.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L40) Title normalizations the pageSet applied before the purge (e.g. underscore and capitalization fixes), same shape as `query.normalized`. *** ### purge > **purge**: [`ApiPurgeEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiPurgeEntry.md)\[] Defined in: [core/purge.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L34) Result of `action=purge`; one entry per targeted page. *** ### redirects? > `optional` **redirects?**: [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md)\[] Defined in: [core/purge.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/purge.ts#L46) Redirect resolutions (with `redirects=1`). *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerField.md --- > 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: ApiQueryAuthManagerField Defined in: [core/query/authmanagerinfo.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L63) A single field descriptor of an [ApiQueryAuthManagerInfoRequest](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md). ## Properties ### help? > `optional` **help?**: [`ApiAuthManagerMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) Defined in: [core/query/authmanagerinfo.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L77) Help text. *** ### label? > `optional` **label?**: [`ApiAuthManagerMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) Defined in: [core/query/authmanagerinfo.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L74) Rendered label. *** ### optional? > `optional` **optional?**: `boolean` Defined in: [core/query/authmanagerinfo.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L80) The field may be omitted. *** ### options? > `optional` **options?**: `Record`\<`string`, `string`> Defined in: [core/query/authmanagerinfo.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L71) Allowed values mapped to their rendered labels, for choice-like fields. *** ### sensitive? > `optional` **sensitive?**: `boolean` Defined in: [core/query/authmanagerinfo.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L83) The field carries a secret (password) and is masked. *** ### type? > `optional` **type?**: `string` Defined in: [core/query/authmanagerinfo.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L65) Input type (e.g. `string`, `password`, `info`). *** ### value? > `optional` **value?**: `string` Defined in: [core/query/authmanagerinfo.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L68) The field's current value (e.g. a username prefilled by a preserved session). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfo.md --- > 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: ApiQueryAuthManagerInfo Defined in: [core/query/authmanagerinfo.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L87) The `authmanagerinfo` object returned under `query`. ## Properties ### canauthenticatenow > **canauthenticatenow**: `boolean` Defined in: [core/query/authmanagerinfo.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L89) Whether the current session can authenticate right now. *** ### cancreateaccounts > **cancreateaccounts**: `boolean` Defined in: [core/query/authmanagerinfo.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L92) Whether account creation is available. *** ### canlinkaccounts > **canlinkaccounts**: `boolean` Defined in: [core/query/authmanagerinfo.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L95) Whether account linking (CentralAuth) is available. *** ### fields? > `optional` **fields?**: `Record`\<`string`, [`ApiQueryAuthManagerField`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerField.md)> Defined in: [core/query/authmanagerinfo.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L117) Field descriptors merged across all [requests](#requests), present only when the request passed `amimergerequestfields=1` — the per-request `fields` are omitted in that mode. *** ### haspreservedstate? > `optional` **haspreservedstate?**: `boolean` Defined in: [core/query/authmanagerinfo.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L104) Whether a preserved AuthManager state exists for the session. *** ### hasprimarypreservedstate? > `optional` **hasprimarypreservedstate?**: `boolean` Defined in: [core/query/authmanagerinfo.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L107) Whether a preserved _primary_ AuthManager state exists. *** ### preservedusername? > `optional` **preservedusername?**: `string` Defined in: [core/query/authmanagerinfo.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L110) Preserved username, or an empty string when none. *** ### requests? > `optional` **requests?**: [`ApiQueryAuthManagerInfoRequest`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md)\[] Defined in: [core/query/authmanagerinfo.ts:120](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L120) Provider requests the flow needs, ordered. *** ### securitysensitiveoperationstatus? > `optional` **securitysensitiveoperationstatus?**: `string` Defined in: [core/query/authmanagerinfo.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L101) Security-sensitive operation status, present only when `amisecuritysensitiveoperation` names an action. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfoRequest.md --- > 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: ApiQueryAuthManagerInfoRequest Defined in: [core/query/authmanagerinfo.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L42) One AuthManager request descriptor returned by `meta=authmanagerinfo`. ## Properties ### account? > `optional` **account?**: [`ApiAuthManagerMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) Defined in: [core/query/authmanagerinfo.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L56) Provider account label (often the request class name for core providers). *** ### fields? > `optional` **fields?**: `Record`\<`string`, [`ApiQueryAuthManagerField`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerField.md)> Defined in: [core/query/authmanagerinfo.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L59) Field descriptors keyed by field name. *** ### id? > `optional` **id?**: `string` Defined in: [core/query/authmanagerinfo.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L44) Fully-qualified request class name (PHP namespace separators escaped). *** ### metadata? > `optional` **metadata?**: `Record`\<`string`, `unknown`> Defined in: [core/query/authmanagerinfo.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L47) Arbitrary provider metadata; always an object under `formatversion=2` (possibly empty). *** ### provider? > `optional` **provider?**: [`ApiAuthManagerMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAuthManagerMessage.md) Defined in: [core/query/authmanagerinfo.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L53) Human-readable provider name. *** ### required? > `optional` **required?**: `string` & `object` | `"required"` | `"optional"` | `"primary-required"` Defined in: [core/query/authmanagerinfo.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L50) How the request is required for the flow. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryBadRev.md --- > 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: ApiQueryBadRev Defined in: [core/query/index.ts:517](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L517) One requested `revid` that does not exist, keyed by revision id. ## Properties ### missing? > `optional` **missing?**: `true` Defined in: [core/query/index.ts:522](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L522) The revision does not exist. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/index.ts:519](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L519) The requested revision id. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md --- > 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: ApiQueryContinue Defined in: [core/query/index.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L32) Continuation tokens returned by `action=query`. ## See [https://www.mediawiki.org/wiki/API:Continue](https://www.mediawiki.org/wiki/API:Continue) A module used as a generator emits its cursor under the `g`-prefixed form of its list-mode name (`generator=allpages` → `gapcontinue`), so each generator-capable module registers both forms. Modules that cannot act as generators have no `g`-prefixed form (e.g. `list=allusers`, `prop=extlinks`). A module with data left contributes its own cursor. A generator's `g`-prefixed cursor is only emitted once the `prop=` modules it drives have finished, which is also when `batchcomplete: true` appears; while a `prop=` module still has data the generator is not advanced, and only that module's cursor plus the generator parameters carried over come back. Once everything is finished the `continue` key is omitted entirely, though `batchcomplete` is still `true`. The generic [continue](#continue) string reads `||`: `-` means the generator itself is finished, a non-empty first segment names the generator parameters carried into the next request, and an empty first segment means a `prop=` module is still unfinished — it says nothing about the generator. The second segment names the modules a client may skip. ## Indexable > \[`key`: `string`]: `string` | `number` | `undefined` Cursor for a module not named above, under that module's own `continue` / offset parameter name. ## Properties ### accontinue? > `optional` **accontinue?**: `string` Defined in: [core/query/index.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L139) `list=allcategories` *** ### adrcontinue? > `optional` **adrcontinue?**: `string` Defined in: [core/query/index.ts:276](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L276) `list=alldeletedrevisions` *** ### afcontinue? > `optional` **afcontinue?**: `string` Defined in: [core/query/index.ts:288](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L288) `list=allfileusages` *** ### aicontinue? > `optional` **aicontinue?**: `string` Defined in: [core/query/index.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L118) `list=allimages` *** ### alcontinue? > `optional` **alcontinue?**: `string` Defined in: [core/query/index.ts:207](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L207) `list=alllinks` *** ### amfrom? > `optional` **amfrom?**: `string` Defined in: [core/query/index.ts:333](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L333) `meta=allmessages` *** ### apcontinue? > `optional` **apcontinue?**: `string` Defined in: [core/query/index.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L124) `list=allpages` *** ### arcontinue? > `optional` **arcontinue?**: `string` Defined in: [core/query/index.ts:213](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L213) `list=allredirects` *** ### arvcontinue? > `optional` **arvcontinue?**: `string` Defined in: [core/query/index.ts:282](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L282) `list=allrevisions` *** ### atcontinue? > `optional` **atcontinue?**: `string` Defined in: [core/query/index.ts:219](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L219) `list=alltransclusions` *** ### aufrom? > `optional` **aufrom?**: `string` Defined in: [core/query/index.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L186) `list=allusers` (name cursor) *** ### bkcontinue? > `optional` **bkcontinue?**: `string` Defined in: [core/query/index.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L180) `list=blocks` *** ### blcontinue? > `optional` **blcontinue?**: `string` Defined in: [core/query/index.ts:159](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L159) `list=backlinks` *** ### cicontinue? > `optional` **cicontinue?**: `string` Defined in: [core/query/index.ts:321](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L321) `prop=categoryinfo` *** ### clcontinue? > `optional` **clcontinue?**: `string` Defined in: [core/query/index.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L43) `prop=categories` *** ### cmcontinue? > `optional` **cmcontinue?**: `string` Defined in: [core/query/index.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L73) `list=categorymembers` *** ### continue? > `optional` **continue?**: `string` Defined in: [core/query/index.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L34) Generic opaque continue token (often `"||"` or `"-||"`). *** ### dfcontinue? > `optional` **dfcontinue?**: `string` Defined in: [core/query/index.ts:303](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L303) `prop=duplicatefiles` *** ### drcontinue? > `optional` **drcontinue?**: `string` Defined in: [core/query/index.ts:294](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L294) `list=deletedrevs` (deprecated module) *** ### drvcontinue? > `optional` **drvcontinue?**: `string` Defined in: [core/query/index.ts:270](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L270) `prop=deletedrevisions` *** ### eicontinue? > `optional` **eicontinue?**: `string` Defined in: [core/query/index.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L165) `list=embeddedin` *** ### elcontinue? > `optional` **elcontinue?**: `string` Defined in: [core/query/index.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L103) `prop=extlinks` *** ### eucontinue? > `optional` **eucontinue?**: `string` Defined in: [core/query/index.ts:225](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L225) `list=exturlusage` *** ### facontinue? > `optional` **facontinue?**: `string` Defined in: [core/query/index.ts:297](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L297) `list=filearchive` *** ### fucontinue? > `optional` **fucontinue?**: `string` Defined in: [core/query/index.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L67) `prop=fileusage` *** ### gaccontinue? > `optional` **gaccontinue?**: `string` Defined in: [core/query/index.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L142) `generator=allcategories` *** ### gadrcontinue? > `optional` **gadrcontinue?**: `string` Defined in: [core/query/index.ts:279](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L279) `generator=alldeletedrevisions` *** ### gafcontinue? > `optional` **gafcontinue?**: `string` Defined in: [core/query/index.ts:291](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L291) `generator=allfileusages` *** ### gaicontinue? > `optional` **gaicontinue?**: `string` Defined in: [core/query/index.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L121) `generator=allimages` *** ### galcontinue? > `optional` **galcontinue?**: `string` Defined in: [core/query/index.ts:210](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L210) `generator=alllinks` *** ### gapcontinue? > `optional` **gapcontinue?**: `string` Defined in: [core/query/index.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L127) `generator=allpages` *** ### garcontinue? > `optional` **garcontinue?**: `string` Defined in: [core/query/index.ts:216](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L216) `generator=allredirects` *** ### garvcontinue? > `optional` **garvcontinue?**: `string` Defined in: [core/query/index.ts:285](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L285) `generator=allrevisions` *** ### gatcontinue? > `optional` **gatcontinue?**: `string` Defined in: [core/query/index.ts:222](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L222) `generator=alltransclusions` *** ### gblcontinue? > `optional` **gblcontinue?**: `string` Defined in: [core/query/index.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L162) `generator=backlinks` *** ### gclcontinue? > `optional` **gclcontinue?**: `string` Defined in: [core/query/index.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L46) `generator=categories` *** ### gcmcontinue? > `optional` **gcmcontinue?**: `string` Defined in: [core/query/index.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L76) `generator=categorymembers` *** ### gdfcontinue? > `optional` **gdfcontinue?**: `string` Defined in: [core/query/index.ts:306](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L306) `generator=duplicatefiles` *** ### gdrvcontinue? > `optional` **gdrvcontinue?**: `string` Defined in: [core/query/index.ts:273](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L273) `generator=deletedrevisions` *** ### geicontinue? > `optional` **geicontinue?**: `string` Defined in: [core/query/index.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L168) `generator=embeddedin` *** ### geucontinue? > `optional` **geucontinue?**: `string` Defined in: [core/query/index.ts:228](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L228) `generator=exturlusage` *** ### gfucontinue? > `optional` **gfucontinue?**: `string` Defined in: [core/query/index.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L70) `generator=fileusage` *** ### gimcontinue? > `optional` **gimcontinue?**: `string` Defined in: [core/query/index.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L100) `generator=images` *** ### giucontinue? > `optional` **giucontinue?**: `string` Defined in: [core/query/index.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L243) `generator=imageusage` *** ### giwblcontinue? > `optional` **giwblcontinue?**: `string` Defined in: [core/query/index.ts:249](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L249) `generator=iwbacklinks` *** ### glblcontinue? > `optional` **glblcontinue?**: `string` Defined in: [core/query/index.ts:255](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L255) `generator=langbacklinks` *** ### glhcontinue? > `optional` **glhcontinue?**: `string` Defined in: [core/query/index.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L52) `generator=linkshere` *** ### gplcontinue? > `optional` **gplcontinue?**: `string` Defined in: [core/query/index.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L94) `generator=links` *** ### gpsoffset? > `optional` **gpsoffset?**: `number` Defined in: [core/query/index.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L136) `generator=prefixsearch` offset (a number). *** ### gptcontinue? > `optional` **gptcontinue?**: `string` Defined in: [core/query/index.ts:261](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L261) `generator=protectedtitles` *** ### gpwpcontinue? > `optional` **gpwpcontinue?**: `string` Defined in: [core/query/index.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L234) `generator=pageswithprop` *** ### gqpoffset? > `optional` **gqpoffset?**: `number` Defined in: [core/query/index.ts:204](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L204) `generator=querypage` offset (a number). *** ### grccontinue? > `optional` **grccontinue?**: `string` Defined in: [core/query/index.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L85) `generator=recentchanges` *** ### grdcontinue? > `optional` **grdcontinue?**: `string` Defined in: [core/query/index.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L58) `generator=redirects` *** ### grncontinue? > `optional` **grncontinue?**: `string` Defined in: [core/query/index.ts:198](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L198) `generator=random` *** ### grvcontinue? > `optional` **grvcontinue?**: `string` Defined in: [core/query/index.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L40) `generator=revisions` *** ### gsroffset? > `optional` **gsroffset?**: `number` Defined in: [core/query/index.ts:192](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L192) `generator=search` offset (a number). *** ### gtccontinue? > `optional` **gtccontinue?**: `string` Defined in: [core/query/index.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L156) `generator=trackingcategories` #### Since MediaWiki 1.45 *** ### gticontinue? > `optional` **gticontinue?**: `string` Defined in: [core/query/index.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L64) `generator=transcludedin` *** ### gtlcontinue? > `optional` **gtlcontinue?**: `string` Defined in: [core/query/index.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L109) `generator=templates` *** ### gwlcontinue? > `optional` **gwlcontinue?**: `string` Defined in: [core/query/index.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L174) `generator=watchlist` *** ### gwrcontinue? > `optional` **gwrcontinue?**: `string` Defined in: [core/query/index.ts:267](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L267) `generator=watchlistraw` *** ### iicontinue? > `optional` **iicontinue?**: `string` Defined in: [core/query/index.ts:315](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L315) `prop=imageinfo` *** ### iistart? > `optional` **iistart?**: `string` Defined in: [core/query/index.ts:312](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L312) `prop=imageinfo` *** ### imcontinue? > `optional` **imcontinue?**: `string` Defined in: [core/query/index.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L97) `prop=images` *** ### incontinue? > `optional` **incontinue?**: `string` Defined in: [core/query/index.ts:309](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L309) `prop=info` *** ### iucontinue? > `optional` **iucontinue?**: `string` Defined in: [core/query/index.ts:240](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L240) `list=imageusage` *** ### iwblcontinue? > `optional` **iwblcontinue?**: `string` Defined in: [core/query/index.ts:246](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L246) `list=iwbacklinks` *** ### iwcontinue? > `optional` **iwcontinue?**: `string` Defined in: [core/query/index.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L112) `prop=iwlinks` *** ### lblcontinue? > `optional` **lblcontinue?**: `string` Defined in: [core/query/index.ts:252](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L252) `list=langbacklinks` *** ### lecontinue? > `optional` **lecontinue?**: `string` Defined in: [core/query/index.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L177) `list=logevents` *** ### lhcontinue? > `optional` **lhcontinue?**: `string` Defined in: [core/query/index.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L49) `prop=linkshere` *** ### licontinue? > `optional` **licontinue?**: `string` Defined in: [core/query/index.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L115) `meta=languageinfo` *** ### llcontinue? > `optional` **llcontinue?**: `string` Defined in: [core/query/index.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L130) `prop=langlinks` *** ### msfcontinue? > `optional` **msfcontinue?**: `string` Defined in: [core/query/index.ts:300](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L300) `list=mystashedfiles` (numeric `uploadstash` row id) *** ### pccontinue? > `optional` **pccontinue?**: `string` Defined in: [core/query/index.ts:183](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L183) `prop=contributors` *** ### plcontinue? > `optional` **plcontinue?**: `string` Defined in: [core/query/index.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L91) `prop=links` *** ### ppcontinue? > `optional` **ppcontinue?**: `string` Defined in: [core/query/index.ts:318](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L318) `prop=pageprops` *** ### ppncontinue? > `optional` **ppncontinue?**: `string` Defined in: [core/query/index.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L237) `list=pagepropnames` *** ### psoffset? > `optional` **psoffset?**: `number` Defined in: [core/query/index.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L133) `list=prefixsearch` offset (a number, like `sroffset`). *** ### ptcontinue? > `optional` **ptcontinue?**: `string` Defined in: [core/query/index.ts:258](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L258) `list=protectedtitles` *** ### pwpcontinue? > `optional` **pwpcontinue?**: `string` Defined in: [core/query/index.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L231) `list=pageswithprop` *** ### qpoffset? > `optional` **qpoffset?**: `number` Defined in: [core/query/index.ts:201](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L201) `list=querypage` offset (a number, like `sroffset`). *** ### rccontinue? > `optional` **rccontinue?**: `string` Defined in: [core/query/index.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L82) `list=recentchanges` *** ### rdcontinue? > `optional` **rdcontinue?**: `string` Defined in: [core/query/index.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L55) `prop=redirects` *** ### rncontinue? > `optional` **rncontinue?**: `string` Defined in: [core/query/index.ts:195](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L195) `list=random` (a `|`-joined random weight and page id, still a string). *** ### rvcontinue? > `optional` **rvcontinue?**: `string` Defined in: [core/query/index.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L37) `prop=revisions` *** ### siprop? > `optional` **siprop?**: `string` Defined in: [core/query/index.ts:330](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L330) `meta=siteinfo` (unprocessed `siprop` values, pipe-joined) *** ### sroffset? > `optional` **sroffset?**: `number` Defined in: [core/query/index.ts:189](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L189) `list=search` offset (a number, unlike most string cursors). *** ### tccontinue? > `optional` **tccontinue?**: `string` Defined in: [core/query/index.ts:149](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L149) `list=trackingcategories` #### Since MediaWiki 1.45 *** ### tgcontinue? > `optional` **tgcontinue?**: `string` Defined in: [core/query/index.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L88) `list=tags` *** ### ticontinue? > `optional` **ticontinue?**: `string` Defined in: [core/query/index.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L61) `prop=transcludedin` *** ### tlcontinue? > `optional` **tlcontinue?**: `string` Defined in: [core/query/index.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L106) `prop=templates` *** ### type? > `optional` **type?**: `string` Defined in: [core/query/index.ts:336](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L336) `meta=tokens` (unprocessed token types, pipe-joined) *** ### uccontinue? > `optional` **uccontinue?**: `string` Defined in: [core/query/index.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L79) `list=usercontribs` *** ### ususerids? > `optional` **ususerids?**: `string` Defined in: [core/query/index.ts:327](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L327) `list=users` queried by id (remaining ids, pipe-joined) *** ### ususers? > `optional` **ususers?**: `string` Defined in: [core/query/index.ts:324](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L324) `list=users` (remaining names, pipe-joined) *** ### wlcontinue? > `optional` **wlcontinue?**: `string` Defined in: [core/query/index.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L171) `list=watchlist` *** ### wrcontinue? > `optional` **wrcontinue?**: `string` Defined in: [core/query/index.ts:264](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L264) `list=watchlistraw` --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryInterwikiTitle.md --- > 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: ApiQueryInterwikiTitle Defined in: [core/query/index.ts:487](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L487) One title resolved to a foreign wiki through an interwiki prefix. ## Properties ### iw > **iw**: `string` Defined in: [core/query/index.ts:492](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L492) Interwiki prefix that claimed the title. *** ### title > **title**: `string` Defined in: [core/query/index.ts:489](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L489) The supplied title, including its interwiki prefix. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/index.ts:495](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L495) URL of the target page on the foreign wiki (`iwurl=1`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryNormalized.md --- > 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: ApiQueryNormalized Defined in: [core/query/index.ts:346](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L346) One title normalization performed by the query framework. ## Properties ### from? > `optional` **from?**: `string` Defined in: [core/query/index.ts:350](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L350) The title as supplied by the request. *** ### fromencoded? > `optional` **fromencoded?**: `boolean` Defined in: [core/query/index.ts:348](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L348) `true` when the input title was percent-encoded. *** ### to? > `optional` **to?**: `string` Defined in: [core/query/index.ts:352](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L352) The normalized title used for the lookup. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryPage.md --- > 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: ApiQueryPage Defined in: [core/query/querypage.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L40) The `querypage` container: the requested report and its rows. ## Properties ### cached? > `optional` **cached?**: `true` Defined in: [core/query/querypage.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L45) The rows come from the job cache. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### cachedtimestamp? > `optional` **cachedtimestamp?**: `string` Defined in: [core/query/querypage.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L57) When the cached report was built; appears alongside [cached](#cached) when the cache timestamp is known. *** ### disabled? > `optional` **disabled?**: `true` Defined in: [core/query/querypage.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L51) The report is cached but not cacheable, so its rows are withheld. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### maxresults? > `optional` **maxresults?**: `number` Defined in: [core/query/querypage.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L60) Largest result set the report can yield, independent of `qplimit`. *** ### name > **name**: `string` Defined in: [core/query/querypage.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L42) CamelCase report name, e.g. `Ancientpages`. *** ### results? > `optional` **results?**: [`ApiQueryPageResult`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryPageResult.md)\[] Defined in: [core/query/querypage.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L63) Rows of the report. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryPageResult.md --- > 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: ApiQueryPageResult Defined in: [core/query/querypage.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L14) One row of a report. ## Properties ### databaseResult? > `optional` **databaseResult?**: `Record`\<`string`, `string`> Defined in: [core/query/querypage.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L36) Raw database columns the report did not fold into named fields, keyed by column name (all values are strings). Reports that select extra columns — `DoubleRedirects` exposes its `b_*`/`c_*` redirect columns this way — leak them here instead of surfacing each one. *** ### ns > **ns**: `number` Defined in: [core/query/querypage.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L25) Namespace index. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/querypage.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L22) Row timestamp; appears on date-keyed reports (`Ancientpages`). *** ### title > **title**: `string` Defined in: [core/query/querypage.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L28) Full page title. *** ### value? > `optional` **value?**: `string` Defined in: [core/query/querypage.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L19) The report's sort value — a **string** even when it carries a count or a `yyyymmddhhmmss` date (e.g. `"4"`, `"20240115083000"`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryResolvedRedirect.md --- > 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: ApiQueryResolvedRedirect Defined in: [core/query/index.ts:499](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L499) One redirect resolved by the framework (`redirects=1`). ## Extends - [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md).[`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md) ## Properties ### categorysnippet? > `optional` **categorysnippet?**: `string` Defined in: [core/query/search.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L56) Snippet of the matching category. `srprop=categorysnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`categorysnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#categorysnippet) *** ### extensiondata? > `optional` **extensiondata?**: `unknown` Defined in: [core/query/search.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L74) Search-backend extension data, keyed by augmentor name. `srprop=extensiondata`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`extensiondata`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#extensiondata) *** ### from? > `optional` **from?**: `string` Defined in: [core/query/index.ts:480](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L480) The title as supplied. #### Inherited from [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md).[`from`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md#from) *** ### index? > `optional` **index?**: `number` Defined in: [core/query/index.ts:513](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L513) 1-based rank of the redirect source in the generator's ordering, present only when that source was fed by a generator (`generator=search` / `generator=prefixsearch`). The rest of the source's generator data is merged into the entry as well, while `from`/`to`/`tofragment`/`tointerwiki` always win over it. *** ### isfilematch? > `optional` **isfilematch?**: `boolean` Defined in: [core/query/search.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L71) Whether the hit matched a file. `srprop=isfilematch`; a real `boolean`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`isfilematch`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#isfilematch) *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/search.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L32) Namespace index. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#ns) *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/search.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L38) Page id. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#pageid) *** ### redirectsnippet? > `optional` **redirectsnippet?**: `string` Defined in: [core/query/search.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L68) HTML snippet of the redirect target title. `srprop=redirectsnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`redirectsnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#redirectsnippet) *** ### redirecttitle? > `optional` **redirecttitle?**: `string` Defined in: [core/query/search.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L65) Title of the redirect target, if this hit redirects. `srprop=redirecttitle`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`redirecttitle`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#redirecttitle) *** ### sectionsnippet? > `optional` **sectionsnippet?**: `string` Defined in: [core/query/search.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L62) HTML snippet of the section heading. `srprop=sectionsnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`sectionsnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#sectionsnippet) *** ### sectiontitle? > `optional` **sectiontitle?**: `string` Defined in: [core/query/search.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L59) Title of the section the match is in. `srprop=sectiontitle`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`sectiontitle`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#sectiontitle) *** ### size? > `optional` **size?**: `number` Defined in: [core/query/search.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L41) Page size in bytes. `srprop=size`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`size`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#size) *** ### snippet? > `optional` **snippet?**: `string` Defined in: [core/query/search.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L50) HTML snippet of the match, with highlights. `srprop=snippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`snippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#snippet) *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/search.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L47) Last-edit timestamp. `srprop=timestamp`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`timestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#timestamp) *** ### title? > `optional` **title?**: `string` Defined in: [core/query/search.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L35) Full page title. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#title) *** ### titlesnippet? > `optional` **titlesnippet?**: `string` Defined in: [core/query/search.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L53) HTML snippet of the title. `srprop=titlesnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`titlesnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#titlesnippet) *** ### to? > `optional` **to?**: `string` Defined in: [core/query/index.ts:483](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L483) The title it resolved to. #### Inherited from [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md).[`to`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md#to) *** ### tofragment? > `optional` **tofragment?**: `string` Defined in: [core/query/index.ts:501](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L501) Fragment of the target title, when it carries one. *** ### tointerwiki? > `optional` **tointerwiki?**: `string` Defined in: [core/query/index.ts:504](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L504) Interwiki prefix of the target, when it points off-site. *** ### wordcount? > `optional` **wordcount?**: `number` Defined in: [core/query/search.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L44) Word count. `srprop=wordcount`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`wordcount`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#wordcount) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryResponse.md --- > 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: ApiQueryResponse Defined in: [core/query/index.ts:570](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L570) Response of `action=query`. `query` widens as modules get covered. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### continue? > `optional` **continue?**: [`ApiQueryContinue`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md) Defined in: [core/query/index.ts:576](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L576) Cursors to merge into the next request to fetch the following batch, absent once every requested module is exhausted. The keys present depend on which `prop=`/`list=`/`meta=`/`generator=` modules were requested. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### limits? > `optional` **limits?**: `Record`\<`string`, `number`> Defined in: [core/query/index.ts:582](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L582) Effective limits per module, keyed by module name (e.g. `{ categories: 500 }`). *** ### query > **query**: [`ApiQueryResult`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md) Defined in: [core/query/index.ts:579](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L579) Output of the requested `prop=`/`list=`/`meta=` modules. *** ### query-continue? > `optional` **query-continue?**: `Record`\<`string`, `Record`\<`string`, `string` | `number`>> Defined in: [core/query/index.ts:590](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L590) Legacy continuation cursors, keyed by module and then by parameter name, emitted at the root level (not under `query`) when the request sets `rawcontinue=1`. It replaces `continue` / `batchcomplete`, which are not emitted in that mode; `query-noncontinue` may appear alongside it. *** ### query-noncontinue? > `optional` **query-noncontinue?**: `Record`\<`string`, `Record`\<`string`, `string` | `number`>> Defined in: [core/query/index.ts:597](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L597) Parameters carried over from the previous batch that are not continuation cursors, keyed by module and then by parameter name (`rawcontinue=1`). Array values are joined with `|` before serialization. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) *** ### watchlistraw? > `optional` **watchlistraw?**: [`ApiWatchlistRawEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawEntry.md)\[] Defined in: [core/query/watchlistraw.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L35) Raw watchlist titles (`list=watchlistraw`) — a root-level key. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md --- > 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: ApiQueryResult Defined in: [core/query/index.ts:531](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L531) Accumulated shape of the `query` result object. Framework-level keys live here; per-module list/meta keys are merged in by their own files via declaration merging, keeping this open to extension. ## Properties ### abusefilters? > `optional` **abusefilters?**: [`ApiAbuseFilter`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilter.md)\[] Defined in: [extensions/abusefilters.ts:255](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L255) Filters defined on the wiki (`list=abusefilters`). *** ### abuselog? > `optional` **abuselog?**: [`ApiAbuseLogEntry`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogEntry.md)\[] Defined in: [extensions/abusefilters.ts:258](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L258) Events caught by one of the abuse filters (`list=abuselog`). *** ### additionalsearch? > `optional` **additionalsearch?**: `Record`\<`string`, [`ApiSearchInterwikiResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiResult.md)\[]> Defined in: [core/query/search.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L166) Interwiki hits the backend matched inline (`enablerewrites=1`), same shape as [interwikisearch](#interwikisearch). *** ### additionalsearchinfo? > `optional` **additionalsearchinfo?**: [`ApiSearchInterwikiInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiInfo.md) Defined in: [core/query/search.ts:169](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L169) Total-hit counter for [additionalsearch](#additionalsearch). *** ### allcategories? > `optional` **allcategories?**: [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md)\[] Defined in: [core/query/allcategories.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L32) Categories listed by `list=allcategories`. *** ### alldeletedrevisions? > `optional` **alldeletedrevisions?**: [`ApiAllDeletedRevisions`](https://types-mediawiki-response.pages.dev/api/core/ApiAllDeletedRevisions.md)\[] Defined in: [core/query/alldeletedrevisions.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alldeletedrevisions.ts#L26) Deleted revisions grouped by page (`list=alldeletedrevisions`). *** ### allfileusages? > `optional` **allfileusages?**: [`ApiAllLink`](https://types-mediawiki-response.pages.dev/api/core/ApiAllLink.md)\[] Defined in: [core/query/allfileusages.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allfileusages.ts#L14) Used file titles, one row per usage (`list=allfileusages`). *** ### allimages? > `optional` **allimages?**: [`ApiAllImage`](https://types-mediawiki-response.pages.dev/api/core/ApiAllImage.md)\[] Defined in: [core/query/allimages.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allimages.ts#L27) Uploaded files (`list=allimages`). *** ### alllinks? > `optional` **alllinks?**: [`ApiAllLink`](https://types-mediawiki-response.pages.dev/api/core/ApiAllLink.md)\[] Defined in: [core/query/alllinks.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alllinks.ts#L36) Titles linked to (`list=alllinks`), ordered by link target — title, or target id on the linktarget schema — then by source page id. *** ### allmessages? > `optional` **allmessages?**: [`ApiAllMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiAllMessage.md)\[] Defined in: [core/query/allmessages.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allmessages.ts#L49) Interface messages (`meta=allmessages`). *** ### allpages? > `optional` **allpages?**: [`ApiAllPage`](https://types-mediawiki-response.pages.dev/api/core/ApiAllPage.md)\[] Defined in: [core/query/allpages.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allpages.ts#L16) Enumerated pages (`list=allpages`). *** ### allredirects? > `optional` **allredirects?**: [`ApiAllLink`](https://types-mediawiki-response.pages.dev/api/core/ApiAllLink.md)\[] Defined in: [core/query/allredirects.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allredirects.ts#L24) Redirect targets on the wiki (`list=allredirects`). *** ### allrevisions? > `optional` **allrevisions?**: [`ApiAllRevisions`](https://types-mediawiki-response.pages.dev/api/core/ApiAllRevisions.md)\[] Defined in: [core/query/allrevisions.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allrevisions.ts#L24) Revisions grouped by page (`list=allrevisions`). *** ### alltransclusions? > `optional` **alltransclusions?**: [`ApiAllLink`](https://types-mediawiki-response.pages.dev/api/core/ApiAllLink.md)\[] Defined in: [core/query/alltransclusions.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/alltransclusions.ts#L13) Transcluded titles on the wiki (`list=alltransclusions`). *** ### allusers? > `optional` **allusers?**: [`ApiAllusersEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiAllusersEntry.md)\[] Defined in: [core/query/allusers.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allusers.ts#L51) Users listed by `list=allusers`. *** ### authmanagerinfo? > `optional` **authmanagerinfo?**: [`ApiQueryAuthManagerInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryAuthManagerInfo.md) Defined in: [core/query/authmanagerinfo.ts:126](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/authmanagerinfo.ts#L126) AuthManager provider introspection requested via `meta=authmanagerinfo`. *** ### autocreatetempuser? > `optional` **autocreatetempuser?**: [`ApiAutoCreateTempUser`](https://types-mediawiki-response.pages.dev/api/core/ApiAutoCreateTempUser.md) Defined in: [core/query/siteinfo.ts:1013](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L1013) Temporary-account creation config (`siprop=autocreatetempuser`). #### Since MediaWiki 1.41 *** ### autopromote? > `optional` **autopromote?**: [`ApiAutopromoteConditions`](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteConditions.md) Defined in: [core/query/siteinfo.ts:999](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L999) Autopromote conditions per group (`siprop=autopromote`). #### Since MediaWiki 1.42 *** ### autopromoteonce? > `optional` **autopromoteonce?**: [`ApiAutopromoteOnce`](https://types-mediawiki-response.pages.dev/api/core/ApiAutopromoteOnce.md) Defined in: [core/query/siteinfo.ts:1006](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L1006) Autopromote-once hooks and their conditions (`siprop=autopromoteonce`). #### Since MediaWiki 1.42 *** ### babel? > `optional` **babel?**: [`ApiBabelResult`](https://types-mediawiki-response.pages.dev/api/extensions/babel/ApiBabelResult.md) Defined in: [extensions/babel.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/babel.ts#L33) Babel levels of the user named in `babuser` (`meta=babel`). *** ### backlinks? > `optional` **backlinks?**: [`ApiBacklink`](https://types-mediawiki-response.pages.dev/api/core/ApiBacklink.md)\[] Defined in: [core/query/backlinks.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/backlinks.ts#L30) Pages linking to `bltitle` (`list=backlinks`). *** ### badrevids? > `optional` **badrevids?**: `Record`\<`string`, [`ApiQueryBadRev`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryBadRev.md)> Defined in: [core/query/index.ts:557](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L557) Requested `revids` that do not exist, keyed by revision id. Emitted instead of a `pages` entry for that revision. *** ### betafeatures? > `optional` **betafeatures?**: `Record`\<`string`, [`ApiBetaFeature`](https://types-mediawiki-response.pages.dev/api/extensions/betafeatures/ApiBetaFeature.md)> Defined in: [extensions/betafeatures.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/betafeatures.ts#L41) Beta features registered on this wiki, keyed by feature id (`list=betafeatures`). Absent when no features are registered. *** ### blocks? > `optional` **blocks?**: [`ApiBlock`](https://types-mediawiki-response.pages.dev/api/core/ApiBlock.md)\[] Defined in: [core/query/blocks.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/blocks.ts#L125) Active blocks (`list=blocks`). *** ### categorymembers? > `optional` **categorymembers?**: [`ApiCategoryMember`](https://types-mediawiki-response.pages.dev/api/core/ApiCategoryMember.md)\[] Defined in: [core/query/categorymembers.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L43) Category members (`list=categorymembers`). *** ### checkuser? > `optional` **checkuser?**: [`ApiQueryCheckUserResult`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserResult.md) Defined in: [extensions/checkuser.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L191) Result of the requested `curequest` mode (`list=checkuser`). *** ### checkuserformattedblockinfo? > `optional` **checkuserformattedblockinfo?**: [`ApiQueryCheckUserFormattedBlockInfoResult`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserFormattedBlockInfoResult.md) Defined in: [extensions/checkuser.ts:197](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L197) Block status of the requesting user (`meta=checkuserformattedblockinfo`). *** ### checkuserlog? > `optional` **checkuserlog?**: [`ApiQueryCheckUserLogResult`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserLogResult.md) Defined in: [extensions/checkuser.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L194) Entries from the CheckUser log (`list=checkuserlog`). *** ### clientlibraries? > `optional` **clientlibraries?**: [`ApiSoftwareLibrary`](https://types-mediawiki-response.pages.dev/api/core/ApiSoftwareLibrary.md)\[] Defined in: [core/query/siteinfo.ts:992](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L992) Bundled client-side libraries (`siprop=clientlibraries`). #### Since MediaWiki 1.42 *** ### codexicons? > `optional` **codexicons?**: `unknown`\[] | `Record`\<`string`, [`ApiCodexIcon`](https://types-mediawiki-response.pages.dev/api/core/ApiCodexIcon.md)> Defined in: [core/query/codexicons.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/codexicons.ts#L46) Codex icon definitions, keyed by icon name (e.g. `cdxIconInfo`). `list=codexicons&names=…` (`names` is required). Simple icons are raw SVG markup strings; directionality/language-aware icons are definition objects. #### Since MediaWiki 1.44 *** ### configuredpages? > `optional` **configuredpages?**: [`ApiQueryConfiguredPages`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryConfiguredPages.md) Defined in: [extensions/flaggedrevs.ts:227](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L227) Pages with custom review configuration (`list=configuredpages`). *** ### converted? > `optional` **converted?**: [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md)\[] Defined in: [core/query/index.ts:542](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L542) Title conversions applied on a language-variant wiki when the request allowed them (`converttitles`), as `{ from, to }` pairs. *** ### copyuploaddomains? > `optional` **copyuploaddomains?**: `string`\[] Defined in: [core/query/siteinfo.ts:914](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L914) Domains copy-uploads may fetch from (`$wgCopyUploadsDomains`, plus the on-wiki allowlist page since 1.46). `siprop=copyuploaddomains`. #### Since MediaWiki 1.45 *** ### crosssiteajaxdomains? > `optional` **crosssiteajaxdomains?**: `string`\[] Defined in: [core/query/siteinfo.ts:897](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L897) Domains allowed to send authenticated CORS requests, from `$wgCrossSiteAJAXdomains`; always a JSON array (empty when unconfigured). `siprop=crosssiteajaxdomains`. #### Since MediaWiki 1.47 *** ### dbrepllag? > `optional` **dbrepllag?**: [`ApiDbReplLag`](https://types-mediawiki-response.pages.dev/api/core/ApiDbReplLag.md)\[] Defined in: [core/query/siteinfo.ts:973](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L973) Database replica lag (`siprop=dbrepllag`). *** ### defaultoptions? > `optional` **defaultoptions?**: `Record`\<`string`, `string` | `number` | `boolean` | `undefined`> Defined in: [core/query/siteinfo.ts:1016](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L1016) Default user options, keyed by option name (`siprop=defaultoptions`). *** ### ~~deletedrevs?~~ > `optional` **deletedrevs?**: [`ApiDeletedRevs`](https://types-mediawiki-response.pages.dev/api/core/ApiDeletedRevs.md)\[] Defined in: [core/query/deletedrevs.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/deletedrevs.ts#L94) Deleted revisions grouped per page (`list=deletedrevs`). #### Deprecated since MediaWiki 1.25; prefer [ApiQueryResult.alldeletedrevisions](#alldeletedrevisions). *** ### doubleunderscores? > `optional` **doubleunderscores?**: `string`\[] Defined in: [core/query/siteinfo.ts:922](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L922) Behavior-switch magic words (the `__NOTOC__` set). `siprop=doubleunderscores`. #### Since MediaWiki 1.46 *** ### echoarticlereminder? > `optional` **echoarticlereminder?**: [`ApiQueryEchoArticleReminder`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoArticleReminder.md) Defined in: [extensions/echo.ts:401](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L401) Reply to `action=echoarticlereminder`, returned under `query`. *** ### echomarkread? > `optional` **echomarkread?**: [`ApiQueryEchoMarkRead`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoMarkRead.md) Defined in: [extensions/echo.ts:395](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L395) Reply to `action=echomarkread`, returned under `query`. *** ### echomarkseen? > `optional` **echomarkseen?**: [`ApiQueryEchoMarkSeen`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoMarkSeen.md) Defined in: [extensions/echo.ts:398](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L398) Reply to `action=echomarkseen`, returned under `query`. *** ### embeddedin? > `optional` **embeddedin?**: [`ApiEmbeddedIn`](https://types-mediawiki-response.pages.dev/api/core/ApiEmbeddedIn.md)\[] Defined in: [core/query/embeddedin.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/embeddedin.ts#L23) Pages embedding `eititle` (`list=embeddedin`). *** ### entityusage? > `optional` **entityusage?**: [`ApiEntityUsageRow`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageRow.md)\[] Defined in: [extensions/wikibase.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L119) `list=wblistentityusage`: pages using the requested entities. *** ### export? > `optional` **export?**: `string` Defined in: [core/query/index.ts:566](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L566) XML dump of the returned pages (`export=1`). *** ### extensions? > `optional` **extensions?**: [`ApiSiteExtension`](https://types-mediawiki-response.pages.dev/api/core/ApiSiteExtension.md)\[] Defined in: [core/query/siteinfo.ts:949](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L949) Installed extensions and skins with credits (`siprop=extensions`). *** ### extensiontags? > `optional` **extensiontags?**: `string`\[] Defined in: [core/query/siteinfo.ts:958](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L958) Parser extension tags such as `` (`siprop=extensiontags`). *** ### exturlusage? > `optional` **exturlusage?**: [`ApiExtUrlUsage`](https://types-mediawiki-response.pages.dev/api/core/ApiExtUrlUsage.md)\[] Defined in: [core/query/exturlusage.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/exturlusage.ts#L33) Pages using the URL given to `euquery` (`list=exturlusage`). *** ### filearchive? > `optional` **filearchive?**: [`ApiFileArchiveEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiFileArchiveEntry.md)\[] Defined in: [core/query/filearchive.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filearchive.ts#L106) Deleted/overwritten files (`list=filearchive`). *** ### fileextensions? > `optional` **fileextensions?**: [`ApiFileExtension`](https://types-mediawiki-response.pages.dev/api/core/ApiFileExtension.md)\[] Defined in: [core/query/siteinfo.ts:946](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L946) Uploadable file extensions (`siprop=fileextensions`). *** ### functionhooks? > `optional` **functionhooks?**: `string`\[] Defined in: [core/query/siteinfo.ts:961](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L961) Parser function names (`siprop=functionhooks`). *** ### gadgetcategories? > `optional` **gadgetcategories?**: [`ApiGadgetCategory`](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetCategory.md)\[] Defined in: [extensions/gadgets.ts:181](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L181) Gadget categories (`list=gadgetcategories`). *** ### gadgets? > `optional` **gadgets?**: [`ApiGadget`](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadget.md)\[] Defined in: [extensions/gadgets.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L178) Gadgets used on this wiki (`list=gadgets`). *** ### general? > `optional` **general?**: `ApiSiteGeneral` Defined in: [core/query/siteinfo.ts:882](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L882) General site configuration (`meta=siteinfo`, `siprop=general`). *** ### globalallusers? > `optional` **globalallusers?**: [`ApiGlobalCentralUser`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md)\[] Defined in: [extensions/centralauth.ts:378](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L378) All global accounts of the farm, name-ordered (`list=globalallusers`). *** ### globalblocks? > `optional` **globalblocks?**: [`ApiGlobalBlock`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlock.md)\[] Defined in: [extensions/globalblocks.ts:185](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L185) Farm-wide blocks of IPs, ranges or usernames (`list=globalblocks`). *** ### globalgroups? > `optional` **globalgroups?**: [`ApiGlobalGroup`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroup.md)\[] Defined in: [extensions/centralauth.ts:381](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L381) Global groups defined on the farm (`list=globalgroups`). *** ### globalpreferences? > `optional` **globalpreferences?**: [`ApiGlobalPreferencesResult`](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResult.md) Defined in: [extensions/globalpreferences.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L70) The user's farm-wide preferences and their per-wiki overrides (`meta=globalpreferences`). *** ### globaluserinfo? > `optional` **globaluserinfo?**: [`ApiGlobalUserInfo`](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserInfo.md) Defined in: [extensions/globaluserinfo.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L123) Global account of the queried user (`meta=globaluserinfo`). *** ### globalusers? > `optional` **globalusers?**: [`ApiGlobalUserRow`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md)\[] Defined in: [extensions/centralauth.ts:387](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L387) Per-name/per-id global account lookup (`list=globalusers`). #### Since MediaWiki 1.47 *** ### imageusage? > `optional` **imageusage?**: [`ApiImageUsage`](https://types-mediawiki-response.pages.dev/api/core/ApiImageUsage.md)\[] Defined in: [core/query/imageusage.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageusage.ts#L32) Pages using the file given to `iutitle` (`list=imageusage`). *** ### interwiki? > `optional` **interwiki?**: [`ApiQueryInterwikiTitle`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryInterwikiTitle.md)\[] Defined in: [core/query/index.ts:548](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L548) Titles that resolved to an interwiki prefix; the framework does not process them further. *** ### interwikimap? > `optional` **interwikimap?**: [`ApiInterwikiMapEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiInterwikiMapEntry.md)\[] Defined in: [core/query/siteinfo.ts:976](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L976) Interwiki prefixes and their URL templates (`siprop=interwikimap`). *** ### interwikisearch? > `optional` **interwikisearch?**: `Record`\<`string`, [`ApiSearchInterwikiResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiResult.md)\[]> Defined in: [core/query/search.ts:157](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L157) Interwiki search hits keyed by interwiki prefix (`srinterwiki=1`). *** ### interwikisearchinfo? > `optional` **interwikisearchinfo?**: [`ApiSearchInterwikiInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiInfo.md) Defined in: [core/query/search.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L160) Total-hit counter for [interwikisearch](#interwikisearch). *** ### iwbacklinks? > `optional` **iwbacklinks?**: [`ApiIwbacklink`](https://types-mediawiki-response.pages.dev/api/core/ApiIwbacklink.md)\[] Defined in: [core/query/iwbacklinks.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/iwbacklinks.ts#L25) Pages linking to `iwblprefix`:`iwbltitle` (`list=iwbacklinks`). *** ### langbacklinks? > `optional` **langbacklinks?**: [`ApiLangbacklink`](https://types-mediawiki-response.pages.dev/api/core/ApiLangbacklink.md)\[] Defined in: [core/query/langbacklinks.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/langbacklinks.ts#L25) Pages linking to `lbllang`:`lbltitle` (`list=langbacklinks`). *** ### languageinfo? > `optional` **languageinfo?**: `Record`\<`string`, [`ApiLanguageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageInfo.md)> Defined in: [core/query/languageinfo.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/languageinfo.ts#L82) Language information keyed by language code (`meta=languageinfo`). *** ### languages? > `optional` **languages?**: [`ApiSiteLanguage`](https://types-mediawiki-response.pages.dev/api/core/ApiSiteLanguage.md)\[] Defined in: [core/query/siteinfo.ts:979](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L979) Known language codes (`siprop=languages`). *** ### languagestats? > `optional` **languagestats?**: [`ApiLanguageStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiLanguageStatsRow.md)\[] Defined in: [extensions/translate.ts:626](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L626) Per-group completeness of one language (`meta=languagestats`). *** ### languagevariants? > `optional` **languagevariants?**: `Record`\<`string`, `Record`\<`string`, [`ApiLanguageVariant`](https://types-mediawiki-response.pages.dev/api/core/ApiLanguageVariant.md) | `undefined`> | `undefined`> Defined in: [core/query/siteinfo.ts:982](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L982) Variant fallbacks, keyed by language then variant (`siprop=languagevariants`). *** ### libraries? > `optional` **libraries?**: [`ApiSoftwareLibrary`](https://types-mediawiki-response.pages.dev/api/core/ApiSoftwareLibrary.md)\[] Defined in: [core/query/siteinfo.ts:985](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L985) Composer packages (`siprop=libraries`). *** ### linterrors? > `optional` **linterrors?**: [`ApiLintError`](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintError.md)\[] Defined in: [extensions/linter.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L86) Lint error rows matching the requested categories (`list=linterrors`). *** ### linterstats? > `optional` **linterstats?**: [`ApiQueryLinterStats`](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiQueryLinterStats.md) Defined in: [extensions/linter.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L89) Lint-error statistics for this wiki (`meta=linterstats`). *** ### logevents? > `optional` **logevents?**: [`ApiLogEvent`](https://types-mediawiki-response.pages.dev/api/core/ApiLogEvent.md)\[] Defined in: [core/query/logevents.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/logevents.ts#L90) Log events (`list=logevents`). *** ### magicwords? > `optional` **magicwords?**: [`ApiMagicWord`](https://types-mediawiki-response.pages.dev/api/core/ApiMagicWord.md)\[] Defined in: [core/query/siteinfo.ts:967](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L967) Magic words and their aliases (`siprop=magicwords`). *** ### messagecollection? > `optional` **messagecollection?**: [`ApiMessageCollectionRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionRow.md)\[] Defined in: [extensions/translate.ts:638](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L638) Messages of one group and language (`list=messagecollection`). *** ### messagegroups? > `optional` **messagegroups?**: [`ApiTranslateMessageGroup`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateMessageGroup.md)\[] Defined in: [extensions/translate.ts:620](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L620) Message groups of this wiki (`meta=messagegroups`). *** ### messagegroupstats? > `optional` **messagegroupstats?**: [`ApiMessageGroupStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupStatsRow.md)\[] Defined in: [extensions/translate.ts:623](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L623) Per-language completeness of one group (`meta=messagegroupstats`). *** ### messagetranslations? > `optional` **messagetranslations?**: [`ApiMessageTranslation`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageTranslation.md)\[] Defined in: [extensions/translate.ts:629](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L629) Existing translations of one message (`meta=messagetranslations`). *** ### metadata? > `optional` **metadata?**: [`ApiMessageCollectionMetadata`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionMetadata.md) Defined in: [extensions/translate.ts:635](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L635) Workflow/report metadata of the message collection slice (`list=messagecollection`). *** ### mostviewed? > `optional` **mostviewed?**: [`ApiMostViewedPage`](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiMostViewedPage.md)\[] Defined in: [extensions/pageviews.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L62) `list=mostviewed`: the site's most-viewed pages. *** ### mystashedfiles? > `optional` **mystashedfiles?**: [`ApiStashedFile`](https://types-mediawiki-response.pages.dev/api/core/ApiStashedFile.md)\[] Defined in: [core/query/mystashedfiles.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L46) Files the caller has stashed but not published (`list=mystashedfiles`). *** ### namespacealiases? > `optional` **namespacealiases?**: [`ApiNamespaceAlias`](https://types-mediawiki-response.pages.dev/api/core/ApiNamespaceAlias.md)\[] Defined in: [core/query/siteinfo.ts:940](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L940) Localized namespace aliases (`siprop=namespacealiases`). *** ### namespaces? > `optional` **namespaces?**: [`ApiNamespaces`](https://types-mediawiki-response.pages.dev/api/core/ApiNamespaces.md) Defined in: [core/query/siteinfo.ts:925](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L925) Namespace definitions (`meta=siteinfo`, `siprop=namespaces`). *** ### normalized? > `optional` **normalized?**: [`ApiQueryNormalized`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryNormalized.md)\[] Defined in: [core/query/index.ts:533](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L533) Title normalizations applied to the request. *** ### notifications? > `optional` **notifications?**: [`ApiQueryEchoNotifications`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoNotifications.md) Defined in: [extensions/echo.ts:389](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L389) Notifications waiting for the user, with unread counts (`meta=notifications`). *** ### ~~oath?~~ > `optional` **oath?**: [`ApiOATHStatus`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHStatus.md) Defined in: [extensions/oathauth.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L102) Whether OATH two-factor authentication is enabled for the queried user (`meta=oath`). #### Deprecated since MediaWiki 1.46; the reported TOTP status has no replacement in the new API. *** ### oldreviewedpages? > `optional` **oldreviewedpages?**: [`ApiQueryOldReviewedPages`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryOldReviewedPages.md) Defined in: [extensions/flaggedrevs.ts:224](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L224) Pages with changes pending review (`list=oldreviewedpages`). *** ### pageids? > `optional` **pageids?**: `string`\[] Defined in: [core/query/index.ts:563](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L563) Page ids of the returned pages (`indexpageids=1`). JSON map keys are strings, so ids are strings here even under `formatversion=2`. *** ### pagepropnames? > `optional` **pagepropnames?**: [`ApiPagePropName`](https://types-mediawiki-response.pages.dev/api/core/ApiPagePropName.md)\[] Defined in: [core/query/pagepropnames.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pagepropnames.ts#L18) Distinct page property names (`list=pagepropnames`). *** ### pages? > `optional` **pages?**: [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md)\[] Defined in: [core/query/index.ts:536](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L536) Page entries, present for title/pageid/generator-based queries. *** ### pageswithprop? > `optional` **pageswithprop?**: [`ApiPagesWithProp`](https://types-mediawiki-response.pages.dev/api/core/ApiPagesWithProp.md)\[] Defined in: [core/query/pageswithprop.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/pageswithprop.ts#L31) Pages defining `pwppropname` (`list=pageswithprop`). *** ### prefixsearch? > `optional` **prefixsearch?**: [`ApiPrefixSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiPrefixSearchResult.md)\[] Defined in: [core/query/prefixsearch.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/prefixsearch.ts#L30) Prefix-search results (`list=prefixsearch`). *** ### protectedtitles? > `optional` **protectedtitles?**: [`ApiProtectedTitle`](https://types-mediawiki-response.pages.dev/api/core/ApiProtectedTitle.md)\[] Defined in: [core/query/protectedtitles.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L52) Titles protected against creation (`list=protectedtitles`). *** ### protocols? > `optional` **protocols?**: `string`\[] Defined in: [core/query/siteinfo.ts:952](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L952) Recognised URL protocols (`siprop=protocols`). *** ### querypage? > `optional` **querypage?**: [`ApiQueryPage`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryPage.md) Defined in: [core/query/querypage.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/querypage.ts#L69) The requested special-page report (`list=querypage`). *** ### random? > `optional` **random?**: [`ApiRandomPage`](https://types-mediawiki-response.pages.dev/api/core/ApiRandomPage.md)\[] Defined in: [core/query/random.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/random.ts#L33) Randomly selected pages (`list=random`). *** ### readinglistentries? > `optional` **readinglistentries?**: [`ApiReadingListEntry`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListEntry.md)\[] Defined in: [extensions/readinglists.ts:247](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L247) Pages saved in the requested list(s). `list=readinglistentries` (or `generator=readinglistentries`, where the entries feed `pages` and this array comes back empty). *** ### readinglists? > `optional` **readinglists?**: [`ApiReadingListItem`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md)\[] Defined in: [extensions/readinglists.ts:233](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L233) The current user's reading lists. `meta=readinglists`. *** ### readinglists-synctimestamp? > `optional` **readinglists-synctimestamp?**: `string` Defined in: [extensions/readinglists.ts:240](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L240) A sync watermark: querying with this timestamp as `changedsince` guarantees no intervening change is skipped. Sibling of [readinglists](#readinglists), `meta=readinglists`; omitted on continuation requests. *** ### recentchanges? > `optional` **recentchanges?**: [`ApiRecentChange`](https://types-mediawiki-response.pages.dev/api/core/ApiRecentChange.md)\[] Defined in: [core/query/recentchanges.ts:129](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L129) Recent changes (`list=recentchanges`). *** ### redirects? > `optional` **redirects?**: [`ApiQueryResolvedRedirect`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResolvedRedirect.md)\[] Defined in: [core/query/index.ts:551](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L551) Redirects resolved when the request set `redirects=1`. *** ### repos? > `optional` **repos?**: [`ApiFileRepoInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiFileRepoInfo.md)\[] Defined in: [core/query/filerepoinfo.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/filerepoinfo.ts#L65) File repositories (`meta=filerepoinfo`). *** ### restrictions? > `optional` **restrictions?**: [`ApiSiteRestrictions`](https://types-mediawiki-response.pages.dev/api/core/ApiSiteRestrictions.md) Defined in: [core/query/siteinfo.ts:934](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L934) Protection types and levels (`siprop=restrictions`). *** ### rightsinfo? > `optional` **rightsinfo?**: [`ApiRightsInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiRightsInfo.md) Defined in: [core/query/siteinfo.ts:937](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L937) Where the site points for its content-rights statement (`siprop=rightsinfo`). *** ### sbom? > `optional` **sbom?**: [`ApiSbom`](https://types-mediawiki-response.pages.dev/api/core/ApiSbom.md) Defined in: [core/query/siteinfo.ts:906](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L906) Software Bill of Materials in CycloneDX 1.6 form. `siprop=sbom`; requires a named (logged-in, non-temporary) account, so anonymous requests error out. #### Since MediaWiki 1.46 *** ### search? > `optional` **search?**: [`ApiSearchHit`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchHit.md)\[] Defined in: [core/query/search.ts:145](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L145) Search results (`list=search`). *** ### searchinfo? > `optional` **searchinfo?**: [`ApiSearchInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInfo.md) Defined in: [core/query/search.ts:152](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L152) Search summary metadata. Emitted by `list=search`, or by `generator=search` when the request passes `gsrinfo` — the generator form defaults to no `searchinfo` at all. *** ### showhooks? > `optional` **showhooks?**: [`ApiShowHook`](https://types-mediawiki-response.pages.dev/api/core/ApiShowHook.md)\[] Defined in: [core/query/siteinfo.ts:970](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L970) Subscriber list per hook (`siprop=showhooks`). *** ### siteviews? > `optional` **siteviews?**: [`ApiViewCounts`](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiViewCounts.md) Defined in: [extensions/pageviews.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L59) `meta=siteviews`: per-day view counts for the whole site. *** ### skins? > `optional` **skins?**: [`ApiSiteSkin`](https://types-mediawiki-response.pages.dev/api/core/ApiSiteSkin.md)\[] Defined in: [core/query/siteinfo.ts:955](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L955) Installed skins (`siprop=skins`). *** ### specialpagealiases? > `optional` **specialpagealiases?**: [`ApiSpecialPageAlias`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecialPageAlias.md)\[] Defined in: [core/query/siteinfo.ts:943](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L943) Localized special-page aliases (`siprop=specialpagealiases`). *** ### stashimageinfo? > `optional` **stashimageinfo?**: [`ApiStashImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiStashImageInfo.md)\[] Defined in: [core/query/stashimageinfo.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L122) Stashed files named by `siifilekey` (`prop=stashimageinfo`). *** ### statistics? > `optional` **statistics?**: `ApiSiteStatistics` Defined in: [core/query/siteinfo.ts:928](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L928) Site counters (`siprop=statistics`). *** ### tags? > `optional` **tags?**: [`ApiTag`](https://types-mediawiki-response.pages.dev/api/core/ApiTag.md)\[] Defined in: [core/query/tags.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L42) Change-tag definitions (`list=tags`). *** ### tokens? > `optional` **tokens?**: [`ApiQueryTokens`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryTokens.md) Defined in: [core/query/tokens.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L41) Tokens requested via `meta=tokens`. *** ### trackingcategories? > `optional` **trackingcategories?**: [`ApiTrackingCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiTrackingCategory.md)\[] Defined in: [core/query/trackingcategories.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/trackingcategories.ts#L25) Tracking categories listed by `list=trackingcategories`. Entries share the `list=allcategories` shape plus catid; `size`/`hidden` only with the matching `tcprop` values. #### Since MediaWiki 1.45 *** ### unreadnotificationpages? > `optional` **unreadnotificationpages?**: [`ApiQueryEchoUnreadPages`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoUnreadPages.md) Defined in: [extensions/echo.ts:392](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L392) Unread-notification pages grouped per wiki (`meta=unreadnotificationpages`). *** ### unreviewedpages? > `optional` **unreviewedpages?**: [`ApiQueryUnreviewedPages`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryUnreviewedPages.md) Defined in: [extensions/flaggedrevs.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L221) Pages not reviewed to the requested quality level (`list=unreviewedpages`). *** ### uploaddialog? > `optional` **uploaddialog?**: `unknown`\[] | [`ApiUploadDialog`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadDialog.md) Defined in: [core/query/siteinfo.ts:888](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L888) Upload-dialog config (`siprop=uploaddialog`), mirroring `$wgUploadDialog` verbatim; an empty configuration serializes as `[]`. *** ### usercontribs? > `optional` **usercontribs?**: [`ApiUserContrib`](https://types-mediawiki-response.pages.dev/api/core/ApiUserContrib.md)\[] Defined in: [core/query/usercontribs.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L85) A user's contributions (`list=usercontribs`). *** ### usergroups? > `optional` **usergroups?**: [`ApiUserGroup`](https://types-mediawiki-response.pages.dev/api/core/ApiUserGroup.md)\[] Defined in: [core/query/siteinfo.ts:931](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L931) User groups and their rights (`siprop=usergroups`). *** ### userinfo? > `optional` **userinfo?**: [`ApiUserInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiUserInfo.md) Defined in: [core/query/userinfo.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L156) The current effective user (`meta=userinfo`). *** ### users? > `optional` **users?**: [`ApiUser`](https://types-mediawiki-response.pages.dev/api/core/ApiUser.md)\[] Defined in: [core/query/users.ts:206](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L206) User records (`list=users`). *** ### variables? > `optional` **variables?**: `string`\[] Defined in: [core/query/siteinfo.ts:964](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L964) Parser variable ids (`siprop=variables`). *** ### watchlist? > `optional` **watchlist?**: [`ApiWatchlistEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistEntry.md)\[] Defined in: [core/query/watchlist.ts:141](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L141) Watchlist changes (`list=watchlist`). *** ### wikibase? > `optional` **wikibase?**: [`ApiWikibaseInfo`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseInfo.md) Defined in: [extensions/wikibase.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L116) `meta=wikibase`: info about the associated repo. *** ### wikisets? > `optional` **wikisets?**: [`ApiWikiSet`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiWikiSet.md)\[] Defined in: [extensions/centralauth.ts:390](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L390) Wiki sets defined on the farm (`list=wikisets`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryTitlePair.md --- > 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: ApiQueryTitlePair Defined in: [core/query/index.ts:478](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L478) A `{ from, to }` title pair emitted by the query framework. ## Extended by - [`ApiQueryResolvedRedirect`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResolvedRedirect.md) ## Properties ### from? > `optional` **from?**: `string` Defined in: [core/query/index.ts:480](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L480) The title as supplied. *** ### to? > `optional` **to?**: `string` Defined in: [core/query/index.ts:483](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L483) The title it resolved to. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiQueryTokens.md --- > 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: ApiQueryTokens Defined in: [core/query/tokens.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L9) Tokens returned by `meta=tokens`; which keys appear depends on `type`. ## Indexable > \[`token`: `` `${string}token` ``]: `string` | `undefined` Extension-provided tokens follow the same `token` shape, e.g. CentralAuth's `deleteglobalaccounttoken` / `setglobalaccountstatustoken`. ## Properties ### createaccounttoken? > `optional` **createaccounttoken?**: `string` Defined in: [core/query/tokens.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L29) `type=createaccount`. *** ### csrftoken? > `optional` **csrftoken?**: `string` Defined in: [core/query/tokens.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L11) Anti-CSRF token for most write actions. `type=csrf` (the default). *** ### logintoken? > `optional` **logintoken?**: `string` Defined in: [core/query/tokens.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L26) `type=login`. *** ### patroltoken? > `optional` **patroltoken?**: `string` Defined in: [core/query/tokens.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L17) `type=patrol`. *** ### rollbacktoken? > `optional` **rollbacktoken?**: `string` Defined in: [core/query/tokens.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L20) `type=rollback`. *** ### userrightstoken? > `optional` **userrightstoken?**: `string` Defined in: [core/query/tokens.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L23) `type=userrights`. *** ### watchtoken? > `optional` **watchtoken?**: `string` Defined in: [core/query/tokens.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tokens.ts#L14) `type=watch`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRandomPage.md --- > 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: ApiRandomPage Defined in: [core/query/random.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/random.ts#L13) One randomly selected page. ## Properties ### id > **id**: `number` Defined in: [core/query/random.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/random.ts#L15) Page id — keyed `id` here, unlike the `pageid` elsewhere. *** ### ns > **ns**: `number` Defined in: [core/query/random.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/random.ts#L18) Namespace index. *** ### redirect? > `optional` **redirect?**: `boolean` Defined in: [core/query/random.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/random.ts#L27) The page is a redirect. A real `boolean` (explicitly `false` too); present only with `rnfilterredir=all`. *** ### title > **title**: `string` Defined in: [core/query/random.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/random.ts#L21) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRateLimit.md --- > 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: ApiRateLimit Defined in: [core/query/userinfo.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L26) A single rate-limit window under `uiprop=ratelimits`. ## Properties ### hits? > `optional` **hits?**: `number` Defined in: [core/query/userinfo.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L28) Allowed hits in the window. *** ### seconds? > `optional` **seconds?**: `number` Defined in: [core/query/userinfo.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L31) Window length in seconds. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRawMessage.md --- > 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: ApiRawMessage Defined in: [envelope/index.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L59) An i18n message spec nested inside another message's `params` (`errorformat=raw`) when a parameter is itself a message, serialized as `{ message: ApiRawMessage }`. The nested `params` may recursively contain further messages. ## Properties ### key > **key**: `string` Defined in: [envelope/index.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L61) i18n message key of the nested message. *** ### params > **params**: [`ApiMessageParam`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md)\[] Defined in: [envelope/index.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L67) Parameters of the nested message, which may themselves be messages, serialized the same way as [ApiMessage.params](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md#params). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRecentChange.md --- > 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: ApiRecentChange Defined in: [core/query/recentchanges.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L18) One recent-changes entry. `rcprop` controls which fields appear. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### actionhidden? > `optional` **actionhidden?**: `true` Defined in: [core/query/recentchanges.ts:105](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L105) The log action is hidden (log-deleted). `rcprop=ids|title|loginfo`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### anon? > `optional` **anon?**: `true` Defined in: [core/query/recentchanges.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L95) Made by an anonymous (IP) editor. `rcprop=user|userid`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md) (appears only when true, unlike this module's real-boolean `flags`). *** ### autopatrolled? > `optional` **autopatrolled?**: `boolean` Defined in: [core/query/recentchanges.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L65) Auto-patrolled flag. `rcprop=patrolled`. *** ### bot? > `optional` **bot?**: `boolean` Defined in: [core/query/recentchanges.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L47) Whether the change was made by a bot. `rcprop=flags`; a real `boolean`. *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/recentchanges.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L80) Raw summary. `rcprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### logaction? > `optional` **logaction?**: `string` Defined in: [core/query/recentchanges.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L117) Log action, e.g. `create`. `rcprop=loginfo`. *** ### logid? > `optional` **logid?**: `number` Defined in: [core/query/recentchanges.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L111) Log id. `rcprop=loginfo` (only for `type=log`). *** ### logparams? > `optional` **logparams?**: [`ApiLogEventParams`](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md) Defined in: [core/query/recentchanges.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L123) Structured log details — see [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md). `rcprop=loginfo` (only for `type=log`). *** ### logtype? > `optional` **logtype?**: `string` Defined in: [core/query/recentchanges.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L114) Log type, e.g. `newusers`. `rcprop=loginfo`. *** ### minor? > `optional` **minor?**: `boolean` Defined in: [core/query/recentchanges.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L53) Whether the edit was minor. `rcprop=flags`; a real `boolean`. *** ### new? > `optional` **new?**: `boolean` Defined in: [core/query/recentchanges.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L50) Whether the change created a new page. `rcprop=flags`; a real `boolean`. *** ### newlen? > `optional` **newlen?**: `number` Defined in: [core/query/recentchanges.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L74) New revision size in bytes. `rcprop=sizes`. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/recentchanges.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L23) Namespace index. *** ### old_revid? > `optional` **old_revid?**: `number` Defined in: [core/query/recentchanges.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L35) Previous revision id. `rcprop=ids`. *** ### oldlen? > `optional` **oldlen?**: `number` Defined in: [core/query/recentchanges.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L71) Old revision size in bytes. `rcprop=sizes`. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/recentchanges.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L29) Page id; `0` for log entries without a page. `rcprop=ids`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/recentchanges.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L83) HTML-rendered summary. `rcprop=parsedcomment`. *** ### patrolled? > `optional` **patrolled?**: `boolean` Defined in: [core/query/recentchanges.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L62) Whether the change has been patrolled (manually or automatically). `rcprop=patrolled` (requires rights). *** ### rcid? > `optional` **rcid?**: `number` Defined in: [core/query/recentchanges.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L38) Recent-changes record id. `rcprop=ids`. *** ### redirect? > `optional` **redirect?**: `boolean` Defined in: [core/query/recentchanges.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L56) Whether the target is a redirect. `rcprop=redirect`; a real `boolean`. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/recentchanges.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L32) Revision id; `0` for log entries. `rcprop=ids`. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/recentchanges.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L89) Content checksum (hex). `rcprop=sha1`. *** ### sha1hidden? > `optional` **sha1hidden?**: `true` Defined in: [core/query/recentchanges.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L108) `sha1` is withheld because the content is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [core/query/recentchanges.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L86) Change tags. `rcprop=tags`. *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/recentchanges.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L102) The actor is a temporary account. `rcprop=user|userid`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/recentchanges.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L77) Change timestamp. `rcprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/recentchanges.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L26) Page title. *** ### type > **type**: [`RecentChangeType`](https://types-mediawiki-response.pages.dev/api/core/RecentChangeType.md) Defined in: [core/query/recentchanges.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L20) Change type. *** ### unpatrolled? > `optional` **unpatrolled?**: `boolean` Defined in: [core/query/recentchanges.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L68) Unpatrolled flag. `rcprop=patrolled`. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/recentchanges.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L41) Actor user name or IP. `rcprop=user`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/recentchanges.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L44) Actor user id. `rcprop=userid`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRedirect.md --- > 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: ApiRedirect Defined in: [core/query/redirects.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/redirects.ts#L10) One redirect entry. `rdprop` controls which fields appear. ## Properties ### fragment? > `optional` **fragment?**: `string` Defined in: [core/query/redirects.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/redirects.ts#L24) Section/anchor fragment the redirect points to. `rdprop=fragment`. Omitted entirely when the redirect has no fragment. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/redirects.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/redirects.ts#L15) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/redirects.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/redirects.ts#L12) Page id of the redirect. `rdprop=pageid`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/redirects.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/redirects.ts#L18) Full title of the redirect page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRemoveAuthenticationDataResponse.md --- > 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: ApiRemoveAuthenticationDataResponse Defined in: [core/removeauthenticationdata.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/removeauthenticationdata.ts#L14) Response of `action=removeauthenticationdata`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### removeauthenticationdata > **removeauthenticationdata**: `object` Defined in: [core/removeauthenticationdata.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/removeauthenticationdata.ts#L16) Result of `action=removeauthenticationdata`. #### status > **status**: `"success"` Flow outcome; `success` when the data was removed. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiResetPasswordResponse.md --- > 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: ApiResetPasswordResponse Defined in: [core/resetpassword.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/resetpassword.ts#L12) Response of `action=resetpassword`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### resetpassword > **resetpassword**: `object` Defined in: [core/resetpassword.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/resetpassword.ts#L14) Result of `action=resetpassword`. #### status > **status**: `"success"` Reset outcome; `success` when the reset was performed or queued. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiResponseWith.md --- > 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. # Type Alias: ApiResponseWith\ > **ApiResponseWith**\<`TSuccess`> = [`ApiErrorResponse`](https://types-mediawiki-response.pages.dev/api/core/ApiErrorResponse.md) | `TSuccess` & [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) Defined in: [envelope/index.ts:224](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L224) Discriminated union helper: a response is either successful or an error. ## Type Parameters ### TSuccess `TSuccess` --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevision.md --- > 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: ApiRevision Defined in: [core/query/revisions.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L92) A single revision entry in `pages[].revisions`. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### anon? > `optional` **anon?**: `true` Defined in: [core/query/revisions.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L103) Made by an anonymous (IP) editor. `rvprop=user|userid`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### badcontentformat? > `optional` **badcontentformat?**: `true` Defined in: [core/query/revisions.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L180) The requested content format is not supported by this revision's model. Top level only when `rvslots=` is not used; with `rvslots=` each slot carries its own `badcontentformat`. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/revisions.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L142) Raw edit summary. `rvprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/revisions.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L166) The edit summary is hidden (revision-deleted). `rvprop=comment|parsedcomment` on a suppressed revision; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Reviewers with the delete right still see `comment` (often the empty string); other viewers see it withheld. #### Overrides [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### content? > `optional` **content?**: `string` Defined in: [core/query/revisions.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L133) Legacy top-level content body. Only when `rvslots=` is **not** used, together with `rvprop=content`; with `rvslots=` the body lives in each slot. *** ### contentformat? > `optional` **contentformat?**: [`ContentFormat`](https://types-mediawiki-response.pages.dev/api/core/ContentFormat.md) Defined in: [core/query/revisions.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L139) Serialization format of the legacy top-level [content](#content). Only when `rvslots=` is not used, with `rvprop=content`. *** ### contentmodel? > `optional` **contentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/revisions.ts:126](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L126) Content model of the main slot at this revision. `rvprop=contentmodel`, and also emitted alongside the legacy top-level [content](#content) body (`rvprop=content`). Top level only when `rvslots=` is not used; with `rvslots=` the content model lives in each slot. *** ### diff? > `optional` **diff?**: [`ApiRevisionDiff`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDiff.md) Defined in: [core/query/revisions.ts:197](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L197) Diff of this revision against `rvdiffto`/`rvdifftotext` (both deprecated; prefer `action=compare`). *** ### minor? > `optional` **minor?**: `boolean` Defined in: [core/query/revisions.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L100) Whether the edit was marked minor. `rvprop=flags`; a real `boolean` (present as `false`). *** ### parentid? > `optional` **parentid?**: `number` Defined in: [core/query/revisions.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L97) Previous revision id; `0` for the first revision of a page. `rvprop=ids`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/revisions.ts:145](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L145) HTML-rendered edit summary. `rvprop=parsedcomment`. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/revisions.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L94) Revision id. `rvprop=ids`. *** ### roles? > `optional` **roles?**: `string`\[] Defined in: [core/query/revisions.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L151) Slot roles present on this revision, e.g. `["main"]`. `rvprop=roles`. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/revisions.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L118) SHA-1 of the revision content (hex). `rvprop=sha1`. May be empty (`''`). *** ### sha1hidden? > `optional` **sha1hidden?**: `true` Defined in: [core/query/revisions.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L194) The SHA-1 (`sha1`) is withheld because the content is revision-deleted. `rvprop=sha1`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### size? > `optional` **size?**: `number` Defined in: [core/query/revisions.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L115) Revision size in bytes. `rvprop=size`. *** ### slots? > `optional` **slots?**: [`ApiRevisionSlots`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlots.md) Defined in: [core/query/revisions.ts:159](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L159) Content slots. Requires `rvslots=` together with one of `rvprop=content`, `contentmodel`, `slotsize`, `slotsha1`; with none of those `rvprop` values no `slots` map is returned. Without `rvslots=` the content fields appear at the top level instead (legacy). *** ### slotsmissing? > `optional` **slotsmissing?**: `true` Defined in: [core/query/revisions.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L200) A slot could not be read for this revision (slot access failure); a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [core/query/revisions.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L148) Change tags applied to this revision. `rvprop=tags`. *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/revisions.ts:188](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L188) The editor is a temporary account. `rvprop=user|userid` on a temp-account revision; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 *** ### texthidden? > `optional` **texthidden?**: `true` Defined in: [core/query/revisions.ts:173](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L173) The revision content is hidden (revision-deleted); a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Top level only when `rvslots=` is not used; with `rvslots=` each slot carries its own `texthidden`. *** ### textmissing? > `optional` **textmissing?**: `true` Defined in: [core/query/revisions.ts:207](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L207) The revision has no content to return (e.g. deleted text). Top level only when `rvslots=` is not used; with `rvslots=` each slot carries its own `textmissing`. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/revisions.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L112) Revision timestamp. `rvprop=timestamp`. *** ### user? > `optional` **user?**: `string` Defined in: [core/query/revisions.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L106) Editor user name. `rvprop=user`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/revisions.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L109) Editor user id; `0` for anonymous editors. `rvprop=userid`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteItem.md --- > 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: ApiRevisionDeleteItem Defined in: [core/revisiondelete.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L23) One item (revision / log entry / image) processed by the request. ## Properties ### action? > `optional` **action?**: `string` Defined in: [core/revisiondelete.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L55) Log action (subtype, e.g. `move_redir`). Log entries only. *** ### actionhidden? > `optional` **actionhidden?**: `boolean` Defined in: [core/revisiondelete.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L58) Whether the log action text is now hidden. A real `boolean`. Log entries only. *** ### archivename? > `optional` **archivename?**: `string` Defined in: [core/revisiondelete.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L67) Archived file name. File versions only. *** ### comment? > `optional` **comment?**: `string` Defined in: [core/revisiondelete.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L49) Edit summary (visible to reviewers). *** ### commenthidden? > `optional` **commenthidden?**: `boolean` Defined in: [core/revisiondelete.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L34) Whether the edit summary is now hidden. A real `boolean`. *** ### contenthidden? > `optional` **contenthidden?**: `boolean` Defined in: [core/revisiondelete.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L79) Whether the file content is now hidden. A real `boolean`. File versions only. *** ### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/revisiondelete.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L85) In-band messages when this item failed, shaped per the request's `errorformat`. *** ### height? > `optional` **height?**: `number` Defined in: [core/revisiondelete.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L73) File height in pixels. File versions only. *** ### id > **id**: `number` Defined in: [core/revisiondelete.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L28) Object id (revision id, log id, or oldimage id). *** ### params? > `optional` **params?**: `Record`\<`string`, `unknown`> Defined in: [core/revisiondelete.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L61) Log entry parameters (when the action is visible). Log entries only. *** ### size? > `optional` **size?**: `number` Defined in: [core/revisiondelete.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L76) File size in bytes. File versions only. *** ### status > **status**: [`RevisionDeleteStatus`](https://types-mediawiki-response.pages.dev/api/core/RevisionDeleteStatus.md) Defined in: [core/revisiondelete.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L25) Outcome for this item. *** ### texthidden? > `optional` **texthidden?**: `boolean` Defined in: [core/revisiondelete.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L40) Whether the content is now hidden. A real `boolean`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/revisiondelete.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L31) Object timestamp. *** ### title? > `optional` **title?**: `string` Defined in: [core/revisiondelete.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L64) File title. File versions only. *** ### type? > `optional` **type?**: `string` Defined in: [core/revisiondelete.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L52) Log entry type (e.g. `move`). Log entries only. *** ### url? > `optional` **url?**: `string` Defined in: [core/revisiondelete.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L82) File URL, or a `Special:Revisiondelete` link when the content is deleted but viewable. File versions only. *** ### user? > `optional` **user?**: `string` Defined in: [core/revisiondelete.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L46) Author name (visible to reviewers). *** ### userhidden? > `optional` **userhidden?**: `boolean` Defined in: [core/revisiondelete.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L37) Whether the author is now hidden. A real `boolean`. *** ### userid? > `optional` **userid?**: `number` Defined in: [core/revisiondelete.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L43) Author user id (visible to reviewers). *** ### warnings? > `optional` **warnings?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/revisiondelete.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L88) In-band warnings for this item, shaped per the request's `errorformat`. *** ### width? > `optional` **width?**: `number` Defined in: [core/revisiondelete.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L70) File width in pixels. File versions only. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResponse.md --- > 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: ApiRevisionDeleteResponse Defined in: [core/revisiondelete.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L110) Response of `action=revisiondelete`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### revisiondelete > **revisiondelete**: [`ApiRevisionDeleteResult`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResult.md) Defined in: [core/revisiondelete.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L112) Result of `action=revisiondelete`. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteResult.md --- > 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: ApiRevisionDeleteResult Defined in: [core/revisiondelete.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L92) The `revisiondelete` object of a successful response. ## Properties ### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/revisiondelete.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L103) In-band messages when the overall operation failed, shaped per the request's `errorformat`. *** ### items > **items**: [`ApiRevisionDeleteItem`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDeleteItem.md)\[] Defined in: [core/revisiondelete.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L100) Per-item results. *** ### status > **status**: [`RevisionDeleteStatus`](https://types-mediawiki-response.pages.dev/api/core/RevisionDeleteStatus.md) Defined in: [core/revisiondelete.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L94) Overall outcome. *** ### target > **target**: `string` Defined in: [core/revisiondelete.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L97) Target page title. *** ### warnings? > `optional` **warnings?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/revisiondelete.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L106) In-band warnings from the overall operation, shaped per the request's `errorformat`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevisionDiff.md --- > 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: ApiRevisionDiff Defined in: [core/query/revisions.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L74) Diff output attached to a revision (`rvdiffto`/`rvdifftotext`; both request parameters are deprecated — prefer `action=compare`). ## Properties ### badcontentformat? > `optional` **badcontentformat?**: `true` Defined in: [core/query/revisions.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L88) The content format is not supported, so no diff was built; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### body? > `optional` **body?**: `string` Defined in: [core/query/revisions.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L82) Rendered HTML diff table. *** ### from? > `optional` **from?**: `number` Defined in: [core/query/revisions.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L76) Revision id the diff starts from. *** ### notcached? > `optional` **notcached?**: `true` Defined in: [core/query/revisions.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L85) The diff was not cached and was computed at request time; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### to? > `optional` **to?**: `number` Defined in: [core/query/revisions.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L79) Revision id the diff ends at. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlot.md --- > 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: ApiRevisionSlot Defined in: [core/query/revisions.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L16) One content slot of a revision (a revision may have multiple named slots). ## Properties ### badcontentformat? > `optional` **badcontentformat?**: `true` Defined in: [core/query/revisions.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L49) The requested content format is not supported by this slot's model. `rvprop=content`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### content? > `optional` **content?**: `string` Defined in: [core/query/revisions.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L55) Slot body. `rvprop=content`. Absent when the text is suppressed (see [ApiRevisionSlot.texthidden](#texthidden)) or not requested. *** ### contentformat? > `optional` **contentformat?**: [`ContentFormat`](https://types-mediawiki-response.pages.dev/api/core/ContentFormat.md) Defined in: [core/query/revisions.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L21) Serialization format of this slot, e.g. `text/x-wiki`. `rvprop=content`. *** ### contentmodel? > `optional` **contentmodel?**: [`ContentModel`](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md) Defined in: [core/query/revisions.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L18) Content model of this slot, e.g. `wikitext`. `rvprop=contentmodel`. *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/revisions.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L36) The slot could not be read for this revision; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### nosuchsection? > `optional` **nosuchsection?**: `true` Defined in: [core/query/revisions.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L46) The requested `rvsection` does not exist in this slot; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Without `rvslots=` the same condition surfaces as a `nosuchsection` API error instead. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/revisions.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L27) Slot content checksum (hex). `rvprop=slotsha1`. May be empty (`''`). *** ### sha1hidden? > `optional` **sha1hidden?**: `true` Defined in: [core/query/revisions.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L33) The slot checksum is hidden (revision-deleted). `rvprop=slotsha1`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### size? > `optional` **size?**: `number` Defined in: [core/query/revisions.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L24) Slot size in bytes. `rvprop=slotsize`. *** ### texthidden? > `optional` **texthidden?**: `true` Defined in: [core/query/revisions.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L30) The slot content is hidden (revision-deleted). `rvprop=content`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### textmissing? > `optional` **textmissing?**: `true` Defined in: [core/query/revisions.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L39) The slot has no content to return (e.g. deleted text); a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlots.md --- > 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: ApiRevisionSlots Defined in: [core/query/revisions.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L62) The `slots` map, keyed by slot role. `main` is the default slot; extensions may add others (e.g. `top`, `bottom`). The index signature keeps it open. ## Indexable > \[`role`: `string`]: [`ApiRevisionSlot`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlot.md) | `undefined` Any other slot, keyed by its role. ## Properties ### main? > `optional` **main?**: [`ApiRevisionSlot`](https://types-mediawiki-response.pages.dev/api/core/ApiRevisionSlot.md) Defined in: [core/query/revisions.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/revisions.ts#L64) The default slot. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRightsInfo.md --- > 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: ApiRightsInfo Defined in: [core/query/siteinfo.ts:425](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L425) `siprop=rightsinfo`: where to read the site's content-rights statement. ## Properties ### text > **text**: `string` Defined in: [core/query/siteinfo.ts:430](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L430) Link text override; empty string when unset. *** ### url > **url**: `string` Defined in: [core/query/siteinfo.ts:427](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L427) Rights-page/account URL; empty string when unset (not absent). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResponse.md --- > 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: ApiRollbackResponse Defined in: [core/rollback.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L32) Response of `action=rollback`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### rollback > **rollback**: [`ApiRollbackResult`](https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResult.md) Defined in: [core/rollback.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L34) Result of `action=rollback`. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiRollbackResult.md --- > 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: ApiRollbackResult Defined in: [core/rollback.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L11) The `rollback` object of an `action=rollback` response. ## Properties ### last_revid > **last_revid**: `number` Defined in: [core/rollback.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L28) Revision id rolled back to (the last good one). *** ### old_revid > **old_revid**: `number` Defined in: [core/rollback.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L25) Revision id that was reverted (the latest bad one). *** ### pageid > **pageid**: `number` Defined in: [core/rollback.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L16) Page id. *** ### revid > **revid**: `number` Defined in: [core/rollback.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L22) Revision id created by the rollback. *** ### summary > **summary**: `string` Defined in: [core/rollback.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L19) Auto-generated rollback summary. *** ### title > **title**: `string` Defined in: [core/rollback.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/rollback.ts#L13) Rolled-back page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSbom.md --- > 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: ApiSbom Defined in: [core/query/siteinfo.ts:853](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L853) Software Bill of Materials in CycloneDX 1.6 form (`siprop=sbom`). Requires a named (logged-in, non-temporary) account. `serialNumber` embeds a fresh UUID per request. ## Since MediaWiki 1.46 ## See [https://cyclonedx.org/docs/1.6/json/](https://cyclonedx.org/docs/1.6/json/) ## Properties ### $schema? > `optional` **$schema?**: `string` Defined in: [core/query/siteinfo.ts:855](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L855) JSON schema URL, `http://cyclonedx.org/schema/bom-1.6.schema.json`. *** ### bomFormat? > `optional` **bomFormat?**: `string` Defined in: [core/query/siteinfo.ts:858](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L858) Always `CycloneDX`. *** ### components? > `optional` **components?**: [`ApiSbomComponent`](https://types-mediawiki-response.pages.dev/api/core/ApiSbomComponent.md)\[] Defined in: [core/query/siteinfo.ts:876](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L876) Platform (PHP/ICU/database), MediaWiki core and extension components. *** ### metadata? > `optional` **metadata?**: `object` Defined in: [core/query/siteinfo.ts:870](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L870) BOM-generation metadata. #### timestamp? > `optional` **timestamp?**: `string` When the BOM was generated, in ISO 8601. *** ### serialNumber? > `optional` **serialNumber?**: `string` Defined in: [core/query/siteinfo.ts:864](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L864) Unique BOM serial, `urn:uuid:` + a fresh UUIDv4 per request. *** ### specVersion? > `optional` **specVersion?**: `string` Defined in: [core/query/siteinfo.ts:861](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L861) CycloneDX spec version, e.g. `1.6`. *** ### version? > `optional` **version?**: `number` Defined in: [core/query/siteinfo.ts:867](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L867) BOM revision, always `1`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSbomComponent.md --- > 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: ApiSbomComponent Defined in: [core/query/siteinfo.ts:778](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L778) One component of the CycloneDX SBOM (`siprop=sbom`). Components nest: the platform entries carry their PHP extensions, MediaWiki core carries its composer packages and foreign resources, each extension carries its own composer packages. ## Properties ### authors? > `optional` **authors?**: `object`\[] Defined in: [core/query/siteinfo.ts:793](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L793) Authors; extensions report `{ name }`, composer packages carry the raw `installed.json` entries (`name`, `email`, `homepage`, `role`). #### email? > `optional` **email?**: `string` Contact address, when the author declares one. #### homepage? > `optional` **homepage?**: `string` Author home page. #### name? > `optional` **name?**: `string` Author name. #### role? > `optional` **role?**: `string` Contribution role as declared, e.g. `Developer`. *** ### components? > `optional` **components?**: `ApiSbomComponent`\[] Defined in: [core/query/siteinfo.ts:842](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L842) Nested components (e.g. PHP extensions, composer packages). *** ### description? > `optional` **description?**: `string` Defined in: [core/query/siteinfo.ts:839](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L839) Localized description (from `descriptionmsg`/`description`). *** ### externalReferences? > `optional` **externalReferences?**: `object`\[] Defined in: [core/query/siteinfo.ts:827](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L827) External references of a foreign-resource component (e.g. upstream site). #### type > **type**: `string` & `object` | `"website"` Relationship kind; core emits `website`. Open union. #### url > **url**: `string` Referenced resource; core emits the component's homepage. *** ### licences? > `optional` **licences?**: `string`\[] Defined in: [core/query/siteinfo.ts:808](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L808) License name declared by the extension (`license-name`). *** ### licenses? > `optional` **licenses?**: `object`\[] Defined in: [core/query/siteinfo.ts:812](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L812) SPDX license expressions of foreign-resource components (CycloneDX spelling, distinct from [licences](#licences)). #### expression? > `optional` **expression?**: `string` Compound SPDX license, i.e. one using `AND`/`OR`/`WITH`; given instead of a `license` object. #### license? > `optional` **license?**: `object` A single SPDX license; given instead of an `expression`. ##### license.id > **id**: `string` SPDX license id, e.g. `MIT`. *** ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:783](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L783) Component name, e.g. `PHP`, `MediaWiki`, an extension/skin or package name. *** ### purl? > `optional` **purl?**: `string` Defined in: [core/query/siteinfo.ts:824](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L824) Package URL of a foreign-resource component. *** ### type > **type**: `string` & `object` | `"platform"` | `"library"` | `"application"` Defined in: [core/query/siteinfo.ts:780](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L780) CycloneDX component type, e.g. `platform`, `library`, `application`. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/siteinfo.ts:836](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L836) Home URL declared by the extension. *** ### version? > `optional` **version?**: `string` | `null` Defined in: [core/query/siteinfo.ts:789](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L789) Version string; `null` when a foreign resource declares none, absent when the source does not report one. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSearchHit.md --- > 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. # Type Alias: ApiSearchHit > **ApiSearchHit** = [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md) & `object` Defined in: [core/query/search.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L83) A `list=search` hit. The module writes `ns`, `title` and `pageid` for every hit, before any `srprop` value is considered, so they are required here — unlike [ApiSearchResult](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md), which stays all-optional because `generator=search` merges the same shape into [ApiPage](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) entries. ## Type Declaration ### ns > **ns**: [`NamespaceIndex`](https://types-mediawiki-response.pages.dev/api/core/NamespaceIndex.md) Namespace index. ### pageid > **pageid**: `number` Page id. ### title > **title**: `string` Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSearchInfo.md --- > 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: ApiSearchInfo Defined in: [core/query/search.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L116) Per-search metadata (`list=search`'s `searchinfo` sibling). ## Properties ### approximate_totalhits? > `optional` **approximate_totalhits?**: `true` Defined in: [core/query/search.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L127) Present (and `true`) when [totalhits](#totalhits) is only an approximation, i.e. the backend stopped counting early. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md): the key is omitted rather than set to `false`. #### Since MediaWiki 1.44 *** ### rewrittenquery? > `optional` **rewrittenquery?**: `string` Defined in: [core/query/search.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L136) The query after search-side rewriting (`srinfo=rewrittenquery`). *** ### rewrittenquerysnippet? > `optional` **rewrittenquerysnippet?**: `string` Defined in: [core/query/search.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L139) HTML snippet of the rewritten query, with the changes highlighted (`srinfo=rewrittenquery`). *** ### suggestion? > `optional` **suggestion?**: `string` Defined in: [core/query/search.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L130) Suggested rewrite when the query had no/few results (`srinfo=suggestion`). *** ### suggestionsnippet? > `optional` **suggestionsnippet?**: `string` Defined in: [core/query/search.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L133) HTML snippet of the suggestion, with the changed terms highlighted (`srinfo=suggestion`). *** ### totalhits? > `optional` **totalhits?**: `number` Defined in: [core/query/search.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L118) Total number of matches (may be capped by the search backend). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiInfo.md --- > 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: ApiSearchInterwikiInfo Defined in: [core/query/search.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L110) Total-hit counter of an interwiki search section. ## Properties ### totalhits? > `optional` **totalhits?**: `number` Defined in: [core/query/search.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L112) Total number of interwiki hits across prefixes. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiResult.md --- > 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: ApiSearchInterwikiResult Defined in: [core/query/search.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L101) One interwiki search hit, an element of [ApiQueryResult.interwikisearch](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md#interwikisearch) / [ApiQueryResult.additionalsearch](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResult.md#additionalsearch). Fields follow `srprop` exactly like [ApiSearchResult](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md), except `title` is the bare page name without the namespace, `pageid` is always `0`, and the interwiki namespace/URL fields below are added. ## Extends - [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md) ## Properties ### categorysnippet? > `optional` **categorysnippet?**: `string` Defined in: [core/query/search.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L56) Snippet of the matching category. `srprop=categorysnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`categorysnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#categorysnippet) *** ### extensiondata? > `optional` **extensiondata?**: `unknown` Defined in: [core/query/search.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L74) Search-backend extension data, keyed by augmentor name. `srprop=extensiondata`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`extensiondata`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#extensiondata) *** ### isfilematch? > `optional` **isfilematch?**: `boolean` Defined in: [core/query/search.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L71) Whether the hit matched a file. `srprop=isfilematch`; a real `boolean`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`isfilematch`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#isfilematch) *** ### namespace? > `optional` **namespace?**: `string` Defined in: [core/query/search.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L103) Namespace name on the foreign wiki, as text. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/search.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L32) Namespace index. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#ns) *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/search.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L38) Page id. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#pageid) *** ### redirectsnippet? > `optional` **redirectsnippet?**: `string` Defined in: [core/query/search.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L68) HTML snippet of the redirect target title. `srprop=redirectsnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`redirectsnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#redirectsnippet) *** ### redirecttitle? > `optional` **redirecttitle?**: `string` Defined in: [core/query/search.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L65) Title of the redirect target, if this hit redirects. `srprop=redirecttitle`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`redirecttitle`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#redirecttitle) *** ### sectionsnippet? > `optional` **sectionsnippet?**: `string` Defined in: [core/query/search.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L62) HTML snippet of the section heading. `srprop=sectionsnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`sectionsnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#sectionsnippet) *** ### sectiontitle? > `optional` **sectiontitle?**: `string` Defined in: [core/query/search.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L59) Title of the section the match is in. `srprop=sectiontitle`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`sectiontitle`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#sectiontitle) *** ### size? > `optional` **size?**: `number` Defined in: [core/query/search.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L41) Page size in bytes. `srprop=size`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`size`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#size) *** ### snippet? > `optional` **snippet?**: `string` Defined in: [core/query/search.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L50) HTML snippet of the match, with highlights. `srprop=snippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`snippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#snippet) *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/search.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L47) Last-edit timestamp. `srprop=timestamp`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`timestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#timestamp) *** ### title? > `optional` **title?**: `string` Defined in: [core/query/search.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L35) Full page title. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#title) *** ### titlesnippet? > `optional` **titlesnippet?**: `string` Defined in: [core/query/search.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L53) HTML snippet of the title. `srprop=titlesnippet`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`titlesnippet`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#titlesnippet) *** ### url? > `optional` **url?**: `string` Defined in: [core/query/search.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L106) Full URL of the hit on the foreign wiki. *** ### wordcount? > `optional` **wordcount?**: `number` Defined in: [core/query/search.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L44) Word count. `srprop=wordcount`. #### Inherited from [`ApiSearchResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md).[`wordcount`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md#wordcount) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSearchResult.md --- > 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: ApiSearchResult Defined in: [core/query/search.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L30) One search hit (`list=search`), and the page data `generator=search` injects into a `query.pages` entry. Which fields appear is controlled by `srprop` for `list=search` and by `gsrprop` for `generator=search`. The two differ in their default: `gsrprop` defaults to empty in generator mode, so only `ns`, `title`, `pageid` and the injected `index` appear unless `gsrprop` is passed explicitly. ## Extended by - [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) - [`ApiQueryResolvedRedirect`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryResolvedRedirect.md) - [`ApiSearchInterwikiResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSearchInterwikiResult.md) ## Properties ### categorysnippet? > `optional` **categorysnippet?**: `string` Defined in: [core/query/search.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L56) Snippet of the matching category. `srprop=categorysnippet`. *** ### extensiondata? > `optional` **extensiondata?**: `unknown` Defined in: [core/query/search.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L74) Search-backend extension data, keyed by augmentor name. `srprop=extensiondata`. *** ### isfilematch? > `optional` **isfilematch?**: `boolean` Defined in: [core/query/search.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L71) Whether the hit matched a file. `srprop=isfilematch`; a real `boolean`. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/search.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L32) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/search.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L38) Page id. *** ### redirectsnippet? > `optional` **redirectsnippet?**: `string` Defined in: [core/query/search.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L68) HTML snippet of the redirect target title. `srprop=redirectsnippet`. *** ### redirecttitle? > `optional` **redirecttitle?**: `string` Defined in: [core/query/search.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L65) Title of the redirect target, if this hit redirects. `srprop=redirecttitle`. *** ### sectionsnippet? > `optional` **sectionsnippet?**: `string` Defined in: [core/query/search.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L62) HTML snippet of the section heading. `srprop=sectionsnippet`. *** ### sectiontitle? > `optional` **sectiontitle?**: `string` Defined in: [core/query/search.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L59) Title of the section the match is in. `srprop=sectiontitle`. *** ### size? > `optional` **size?**: `number` Defined in: [core/query/search.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L41) Page size in bytes. `srprop=size`. *** ### snippet? > `optional` **snippet?**: `string` Defined in: [core/query/search.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L50) HTML snippet of the match, with highlights. `srprop=snippet`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/search.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L47) Last-edit timestamp. `srprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/search.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L35) Full page title. *** ### titlesnippet? > `optional` **titlesnippet?**: `string` Defined in: [core/query/search.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L53) HTML snippet of the title. `srprop=titlesnippet`. *** ### wordcount? > `optional` **wordcount?**: `number` Defined in: [core/query/search.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L44) Word count. `srprop=wordcount`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampEntry.md --- > 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: ApiSetNotificationTimestampEntry Defined in: [core/setnotificationtimestamp.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L17) One page entry of an `action=setnotificationtimestamp` response. ## Properties ### invalid? > `optional` **invalid?**: `true` Defined in: [core/setnotificationtimestamp.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L34) The supplied title/revision id is not valid. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### known? > `optional` **known?**: `true` Defined in: [core/setnotificationtimestamp.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L31) A `missing` title that is nonetheless "known". A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### missing? > `optional` **missing?**: `true` Defined in: [core/setnotificationtimestamp.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L28) The title does not correspond to an existing page. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### notificationtimestamp? > `optional` **notificationtimestamp?**: `string` Defined in: [core/setnotificationtimestamp.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L25) New notification timestamp, or `""` when there is nothing pending. *** ### notwatched? > `optional` **notwatched?**: `true` Defined in: [core/setnotificationtimestamp.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L37) The (logged-in) user is not watching this page, so nothing was set. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### ns > **ns**: `number` Defined in: [core/setnotificationtimestamp.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L19) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/setnotificationtimestamp.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L40) Page id of a missing page (`titles`/`pageids` input). *** ### revid? > `optional` **revid?**: `number` Defined in: [core/setnotificationtimestamp.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L43) Revision id of a missing revision (`revids` input). *** ### title > **title**: `string` Defined in: [core/setnotificationtimestamp.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L22) Page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampResponse.md --- > 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: ApiSetNotificationTimestampResponse Defined in: [core/setnotificationtimestamp.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L56) Response of `action=setnotificationtimestamp`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### setnotificationtimestamp > **setnotificationtimestamp**: [`ApiSetNotificationTimestampWatchlistResult`](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampWatchlistResult.md) | [`ApiSetNotificationTimestampEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampEntry.md)\[] Defined in: [core/setnotificationtimestamp.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L58) Result of `action=setnotificationtimestamp`: a per-page list, or one object in `entirewatchlist=1` mode. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSetNotificationTimestampWatchlistResult.md --- > 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: ApiSetNotificationTimestampWatchlistResult Defined in: [core/setnotificationtimestamp.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L50) Whole-watchlist result (`entirewatchlist=1`): a single object instead of the per-page array. ## Properties ### notificationtimestamp? > `optional` **notificationtimestamp?**: `string` Defined in: [core/setnotificationtimestamp.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setnotificationtimestamp.ts#L52) Notification timestamp applied to every watched page, or `""` when nothing was pending. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSetPageLanguageResponse.md --- > 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: ApiSetPageLanguageResponse Defined in: [core/setpagelanguage.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setpagelanguage.ts#L14) Response of `action=setpagelanguage`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### setpagelanguage > **setpagelanguage**: `object` Defined in: [core/setpagelanguage.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/setpagelanguage.ts#L16) Result of `action=setpagelanguage`. #### logid > **logid**: `number` Log entry id recorded for the change. #### newlanguage > **newlanguage**: `string` Language code after the change. #### oldlanguage > **oldlanguage**: `string` Language code before the change (may be suffixed, e.g. `en[def]`). #### title > **title**: `string` Page title. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiShowHook.md --- > 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: ApiShowHook Defined in: [core/query/siteinfo.ts:560](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L560) One hook and its subscribers (`siprop=showhooks`). ## Properties ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:562](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L562) Hook name. *** ### subscribers > **subscribers**: `string`\[] Defined in: [core/query/siteinfo.ts:565](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L565) `Class::method` handlers registered for it. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSiteExtension.md --- > 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: ApiSiteExtension Defined in: [core/query/siteinfo.ts:461](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L461) `siprop=extensions`: one installed extension or skin. Keys other than [type](#type) appear only when the component's `extension.json` declares them. ## Properties ### author? > `optional` **author?**: `string` Defined in: [core/query/siteinfo.ts:499](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L499) Authors, joined with `, ` (links are embedded as URLs). *** ### credits? > `optional` **credits?**: `string` Defined in: [core/query/siteinfo.ts:529](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L529) URL of `Special:Version/Credits/`. *** ### description? > `optional` **description?**: `string` Defined in: [core/query/siteinfo.ts:490](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L490) Literal description, when configured. *** ### descriptionmsg? > `optional` **descriptionmsg?**: `string` Defined in: [core/query/siteinfo.ts:493](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L493) Message key holding the description. *** ### descriptionmsgparams? > `optional` **descriptionmsgparams?**: `string`\[] Defined in: [core/query/siteinfo.ts:496](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L496) Parameters for [descriptionmsg](#descriptionmsg). *** ### license? > `optional` **license?**: `string` Defined in: [core/query/siteinfo.ts:526](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L526) URL of `Special:Version/License/`. *** ### license-name? > `optional` **license-name?**: `string` Defined in: [core/query/siteinfo.ts:523](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L523) License identifier from `extension.json`. *** ### name? > `optional` **name?**: `string` Defined in: [core/query/siteinfo.ts:484](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L484) Display name. *** ### namemsg? > `optional` **namemsg?**: `string` Defined in: [core/query/siteinfo.ts:487](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L487) Message key holding the name. *** ### type > **type**: `string` & `object` | `"specialpage"` | `"editor"` | `"wikifamily"` | `"parserhook"` | `"variable"` | `"media"` | `"antispam"` | `"skin"` | `"api"` | `"other"` Defined in: [core/query/siteinfo.ts:470](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L470) Component class. The names MediaWiki has display labels for are `specialpage`, `editor`, `wikifamily`, `parserhook`, `variable`, `media`, `antispam`, `skin`, `api` and `other`, but the value is never validated against them: a component declares its own `type` in `extension.json`, `$wgExtensionCredits` entries pass through as written, and the `ExtensionTypes` hook can add further names — **open union**. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/siteinfo.ts:502](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L502) Project URL. *** ### vcs-date? > `optional` **vcs-date?**: `string` Defined in: [core/query/siteinfo.ts:520](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L520) VCS commit date of the checkout. *** ### vcs-system? > `optional` **vcs-system?**: `string` Defined in: [core/query/siteinfo.ts:508](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L508) VCS system, e.g. `git`; only for checkout-installed components. *** ### vcs-url? > `optional` **vcs-url?**: `string` | `false` Defined in: [core/query/siteinfo.ts:517](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L517) VCS URL of the checkout; `false` when the repository has no viewable remote URL. *** ### vcs-version? > `optional` **vcs-version?**: `string` Defined in: [core/query/siteinfo.ts:511](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L511) VCS commit of the checkout. *** ### version? > `optional` **version?**: `string` Defined in: [core/query/siteinfo.ts:505](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L505) Declared version. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSiteGeneral.md --- > 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: ApiSiteGeneral Defined in: [core/query/siteinfo.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L70) Fields of `query.general` (`siprop=general`), closed on the 1.43 core key set — extend by declaration merging for site- or extension-specific keys. ## Properties ### allcentralidlookupproviders > **allcentralidlookupproviders**: `string`\[] Defined in: [core/query/siteinfo.ts:294](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L294) All available central-id lookup providers. *** ### allunicodefixes > **allunicodefixes**: `boolean` Defined in: [core/query/siteinfo.ts:189](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L189) Whether all Unicode normalization fixes are applied. A real `boolean`. *** ### articlepath > **articlepath**: `string` Defined in: [core/query/siteinfo.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L109) Path pattern to an article, with `$1` for the title. *** ### base > **base**: `string` Defined in: [core/query/siteinfo.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L75) Canonical URL of the main page. *** ### case > **case**: [`CaseSensitivity`](https://types-mediawiki-response.pages.dev/api/core/CaseSensitivity.md) Defined in: [core/query/siteinfo.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L90) Title case-sensitivity for the wiki. *** ### categorycollation > **categorycollation**: `string` Defined in: [core/query/siteinfo.ts:300](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L300) Category sort order algorithm, e.g. `uppercase` / `unicode`. *** ### centralidlookupprovider > **centralidlookupprovider**: `string` Defined in: [core/query/siteinfo.ts:291](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L291) Method used to look up a user's central account id. *** ### dbtype > **dbtype**: `string` Defined in: [core/query/siteinfo.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L148) DBMS driver, e.g. `sqlite` / `mysql`. *** ### dbversion > **dbversion**: `string` Defined in: [core/query/siteinfo.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L151) DBMS server version string. *** ### externalimages? > `optional` **externalimages?**: `string`\[] Defined in: [core/query/siteinfo.ts:252](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L252) Host prefixes external images may be loaded from; `[""]` when external images are allowed at large (`$wgAllowExternalImages`). *** ### externallinktarget > **externallinktarget**: `string` | `boolean` Defined in: [core/query/siteinfo.ts:279](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L279) `target` for external links. A real `boolean` (`false`) while the site sets no target, otherwise the attribute string such as `_blank`. *** ### fallback > **fallback**: `object`\[] Defined in: [core/query/siteinfo.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L211) Language fallback chain of the content language, one entry per fallback code. An empty PHP list serializes as `[]`. #### code > **code**: `string` Fallback language code. *** ### fallback8bitEncoding > **fallback8bitEncoding**: `string` Defined in: [core/query/siteinfo.ts:217](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L217) Fallback encoding for 8-bit text, e.g. `windows-1252`. *** ### favicon? > `optional` **favicon?**: `string` Defined in: [core/query/siteinfo.ts:246](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L246) Site favicon URL; absent when the site sets no `$wgFavicon`. *** ### ~~fixarabicunicode?~~ > `optional` **fixarabicunicode?**: `true` Defined in: [core/query/siteinfo.ts:197](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L197) Whether Arabic-specific Unicode fixes are applied. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Deprecated since MediaWiki 1.45; the underlying config was removed in 1.35 (the field always reported `true`) and is no longer emitted. *** ### ~~fixmalayalamunicode?~~ > `optional` **fixmalayalamunicode?**: `true` Defined in: [core/query/siteinfo.ts:205](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L205) Whether Malayalam-specific Unicode fixes are applied. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Deprecated since MediaWiki 1.45; the underlying config was removed in 1.35 (the field always reported `true`) and is no longer emitted. *** ### galleryoptions > **galleryoptions**: [`ApiGalleryOptions`](https://types-mediawiki-response.pages.dev/api/core/ApiGalleryOptions.md) Defined in: [core/query/siteinfo.ts:255](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L255) Gallery rendering defaults. *** ### generator > **generator**: `string` Defined in: [core/query/siteinfo.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L84) Generator, e.g. `MediaWiki 1.43.0`. *** ### git-branch? > `optional` **git-branch?**: `string` Defined in: [core/query/siteinfo.ts:309](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L309) Git branch of the deployment; only present on git checkouts. *** ### git-hash? > `optional` **git-hash?**: `string` Defined in: [core/query/siteinfo.ts:312](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L312) Git commit hash of the deployment; only present on git checkouts. *** ### imagelimits > **imagelimits**: `Record`\<`string`, [`ApiImageLimit`](https://types-mediawiki-response.pages.dev/api/core/ApiImageLimit.md)> Defined in: [core/query/siteinfo.ts:264](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L264) Selectable image-display size presets, keyed by position. Always an object under `formatversion=2`. *** ### imagewhitelistenabled? > `optional` **imagewhitelistenabled?**: `boolean` Defined in: [core/query/siteinfo.ts:157](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L157) Whether the image whitelist is active. A real `boolean`, emitted only while the site disallows inline external images (`$wgAllowExternalImages` off). *** ### interwikimagic > **interwikimagic**: `boolean` Defined in: [core/query/siteinfo.ts:282](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L282) Whether interwiki prefixes may be used as magic links. A real `boolean`. *** ### invalidusernamechars > **invalidusernamechars**: `string` Defined in: [core/query/siteinfo.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L186) Characters illegal in usernames. *** ### lang > **lang**: `string` Defined in: [core/query/siteinfo.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L93) Content language code, e.g. `en`. *** ### langconversion > **langconversion**: `boolean` Defined in: [core/query/siteinfo.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L160) Whether language conversion is enabled. A real `boolean`. *** ### legaltitlechars > **legaltitlechars**: `string` Defined in: [core/query/siteinfo.ts:183](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L183) Characters legal in page titles, as a regex character class body. *** ### linkconversion > **linkconversion**: `boolean` Defined in: [core/query/siteinfo.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L171) Whether interwiki-link conversion is enabled. A real `boolean`. *** ### linkprefix > **linkprefix**: `string` Defined in: [core/query/siteinfo.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L177) Link-prefix regex (legacy; `""` when unused). *** ### linkprefixcharset > **linkprefixcharset**: `string` Defined in: [core/query/siteinfo.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L174) Charset allowed for interwiki link prefixes (`""` when unused). *** ### linktrail > **linktrail**: `string` Defined in: [core/query/siteinfo.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L180) Regex deciding how much of a link trails into surrounding text. *** ### logo > **logo**: `string` Defined in: [core/query/siteinfo.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L81) Site logo URL. *** ### magiclinks > **magiclinks**: `unknown`\[] | `Record`\<`string`, `boolean`> Defined in: [core/query/siteinfo.ts:288](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L288) Magic-link keywords and whether each is enabled; mirrors `$wgEnableMagicLinks` verbatim, so an empty set serializes as `[]`. *** ### mainpage > **mainpage**: `string` Defined in: [core/query/siteinfo.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L72) Main page title. *** ### mainpageisdomainroot > **mainpageisdomainroot**: `boolean` Defined in: [core/query/siteinfo.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L142) Whether the main page is served at the domain root (i.e. `$wgArticlePath` is `/$1`). A real `boolean`. *** ### maxarticlesize > **maxarticlesize**: `number` Defined in: [core/query/siteinfo.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L136) Maximum article size in bytes. *** ### maxuploadsize > **maxuploadsize**: `number` Defined in: [core/query/siteinfo.ts:240](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L240) Maximum upload size in bytes; an array `$wgMaxUploadSize` collapses to its `*` entry. *** ### minuploadchunksize > **minuploadchunksize**: `number` Defined in: [core/query/siteinfo.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L243) Minimum chunk size for staged uploads, in bytes. *** ### misermode > **misermode**: `boolean` Defined in: [core/query/siteinfo.ts:297](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L297) Whether misc (miser-mode) features are enabled. A real `boolean`. *** ### nofollowdomainexceptions > **nofollowdomainexceptions**: `string`\[] Defined in: [core/query/siteinfo.ts:273](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L273) Domains exempted from [nofollowlinks](#nofollowlinks). *** ### nofollowlinks > **nofollowlinks**: `boolean` Defined in: [core/query/siteinfo.ts:267](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L267) Whether `nofollow` is added to external links. A real `boolean`. *** ### nofollownsexceptions > **nofollownsexceptions**: `number`\[] Defined in: [core/query/siteinfo.ts:270](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L270) Namespaces exempted from [nofollowlinks](#nofollowlinks). *** ### phpsapi > **phpsapi**: `string` Defined in: [core/query/siteinfo.ts:145](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L145) PHP SAPI name, e.g. `apache2handler` / `fpm-fcgi`. *** ### phpversion > **phpversion**: `string` Defined in: [core/query/siteinfo.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L87) PHP version string. *** ### readonly > **readonly**: `boolean` Defined in: [core/query/siteinfo.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L99) Whether the wiki is read-only. A real `boolean`. *** ### readonlyreason? > `optional` **readonlyreason?**: `string` Defined in: [core/query/siteinfo.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L231) Why the wiki is read-only; only present while [readonly](#readonly) is `true`. *** ### rtl > **rtl**: `boolean` Defined in: [core/query/siteinfo.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L96) Whether the content language is right-to-left. A real `boolean`. *** ### script > **script**: `string` Defined in: [core/query/siteinfo.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L115) Full path to `index.php`. *** ### scriptpath > **scriptpath**: `string` Defined in: [core/query/siteinfo.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L112) Path to `index.php`, without the host. *** ### server > **server**: `string` Defined in: [core/query/siteinfo.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L118) Server host (protocol-relative or bare), e.g. `//www.mediawiki.org`. *** ### servername > **servername**: `string` Defined in: [core/query/siteinfo.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L121) Server host name. *** ### sitename > **sitename**: `string` Defined in: [core/query/siteinfo.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L78) Site name. *** ### thumblimits > **thumblimits**: `Record`\<`string`, `number`> Defined in: [core/query/siteinfo.ts:261](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L261) Selectable thumbnail widths, in pixels, keyed by position. Always an object under `formatversion=2`, even though the value is a list server-side. *** ### time > **time**: `string` Defined in: [core/query/siteinfo.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L127) Current server time. *** ### timeoffset > **timeoffset**: `number` Defined in: [core/query/siteinfo.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L133) Timezone offset from UTC in seconds. *** ### timezone > **timezone**: `string` Defined in: [core/query/siteinfo.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L130) Site timezone id. *** ### ~~titleconversion~~ > **titleconversion**: `boolean` Defined in: [core/query/siteinfo.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L168) Whether title conversion is enabled. A real `boolean`, mirroring [linkconversion](#linkconversion). #### Deprecated Soft-deprecated since MediaWiki 1.36; use `linkconversion`. *** ### uploadsenabled > **uploadsenabled**: `boolean` Defined in: [core/query/siteinfo.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L234) Whether uploads are enabled. A real `boolean` (`$wgEnableUploads`). *** ### variantarticlepath > **variantarticlepath**: `string` | `boolean` Defined in: [core/query/siteinfo.ts:306](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L306) `$wgVariantArticlePath` as configured: the URL pattern, or `false` when unset. *** ### variants? > `optional` **variants?**: `object`\[] Defined in: [core/query/siteinfo.ts:220](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L220) Language variants of the content language; absent without variant support. #### code > **code**: `string` Variant code, e.g. `zh-cn`. #### name > **name**: `string` Variant name in its own language. *** ### wikiid > **wikiid**: `string` Defined in: [core/query/siteinfo.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L124) Wiki id, e.g. `mediawikiwiki`. *** ### ~~writeapi~~ > **writeapi**: `true` Defined in: [core/query/siteinfo.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L106) Whether the write API is enabled. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Deprecated since MediaWiki 1.32; the write API can no longer be disabled. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSiteLanguage.md --- > 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: ApiSiteLanguage Defined in: [core/query/siteinfo.ts:630](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L630) One language entry (`siprop=languages`). ## Properties ### bcp47 > **bcp47**: `string` Defined in: [core/query/siteinfo.ts:635](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L635) BCP 47 form of [code](#code). *** ### code > **code**: `string` Defined in: [core/query/siteinfo.ts:632](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L632) Language code. *** ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:638](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L638) Localized language name. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSiteRestrictions.md --- > 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: ApiSiteRestrictions Defined in: [core/query/siteinfo.ts:410](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L410) `siprop=restrictions`: protection types and levels. `levels` is **not** a flat string list — FlaggedRevs registers a protection class as a nested array, so an element can be `string[]` (e.g. `["sreview"]`). ## Properties ### cascadinglevels > **cascadinglevels**: `string`\[] Defined in: [core/query/siteinfo.ts:418](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L418) Levels that may cascade. *** ### levels > **levels**: (`string` | `string`\[])\[] Defined in: [core/query/siteinfo.ts:415](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L415) Selectable protection levels; `""` means unrestricted. *** ### semiprotectedlevels > **semiprotectedlevels**: `string`\[] Defined in: [core/query/siteinfo.ts:421](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L421) Levels treated as semi-protection. *** ### types > **types**: `string`\[] Defined in: [core/query/siteinfo.ts:412](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L412) Restriction kinds, e.g. `create`, `edit`, `move`, `upload`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSiteSkin.md --- > 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: ApiSiteSkin Defined in: [core/query/siteinfo.ts:533](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L533) One installed skin (`siprop=skins`). ## Properties ### code > **code**: `string` Defined in: [core/query/siteinfo.ts:535](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L535) Skin key, e.g. `vector-2022`. *** ### default? > `optional` **default?**: `true` Defined in: [core/query/siteinfo.ts:541](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L541) Present when the skin is the site default. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:538](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L538) Display name, localized when `skinname-*` exists. *** ### unusable? > `optional` **unusable?**: `true` Defined in: [core/query/siteinfo.ts:544](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L544) Present when the skin is installed but not selectable. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSiteStatistics.md --- > 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: ApiSiteStatistics Defined in: [core/query/siteinfo.ts:352](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L352) Site counters (`siprop=statistics`). ## Properties ### activeusers > **activeusers**: `number` Defined in: [core/query/siteinfo.ts:369](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L369) Users active within the activity window. *** ### admins > **admins**: `number` Defined in: [core/query/siteinfo.ts:372](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L372) Members of the `sysop` group. *** ### articles > **articles**: `number` Defined in: [core/query/siteinfo.ts:357](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L357) Pages in content namespaces. *** ### edits > **edits**: `number` Defined in: [core/query/siteinfo.ts:360](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L360) Total revisions. *** ### images > **images**: `number` Defined in: [core/query/siteinfo.ts:363](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L363) Stored files. *** ### jobs > **jobs**: `number` Defined in: [core/query/siteinfo.ts:375](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L375) Queued jobs. *** ### pages > **pages**: `number` Defined in: [core/query/siteinfo.ts:354](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L354) Total pages in all namespaces. *** ### users > **users**: `number` Defined in: [core/query/siteinfo.ts:366](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L366) Registered users. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSoftwareLibrary.md --- > 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: ApiSoftwareLibrary Defined in: [core/query/siteinfo.ts:648](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L648) One software component (`siprop=libraries` / `siprop=clientlibraries`). ## Properties ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:650](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L650) Package name, e.g. `bacon/bacon-qr-code`. *** ### version > **version**: `string` Defined in: [core/query/siteinfo.ts:653](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L653) Installed version. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md --- > 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: ApiSpecMessage Defined in: [common/index.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L52) A structured in-band message — a serialized MediaWiki `Message`/`FatalError` spec (`{ message, params, code, type }`) nested inside an action result (e.g. password-policy messages, file-backend errors, AuthManager failures). Distinct from `ApiMessage`, which models the `errorformat`-based envelope. ## Properties ### code? > `optional` **code?**: `string` Defined in: [common/index.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L60) Machine-readable code (usually mirrors `message`). *** ### html? > `optional` **html?**: `string` Defined in: [common/index.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L66) Pre-rendered HTML, when the server supplies it. *** ### message? > `optional` **message?**: `string` Defined in: [common/index.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L54) i18n message key, e.g. `passwordtooshort`. *** ### params? > `optional` **params?**: `unknown`\[] Defined in: [common/index.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L57) Parameters substituted into the message (may be numbers). *** ### type? > `optional` **type?**: `string` Defined in: [common/index.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L63) Severity, e.g. `error`. Open union. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiSpecialPageAlias.md --- > 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: ApiSpecialPageAlias Defined in: [core/query/siteinfo.ts:443](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L443) One localized special-page alias (`siprop=specialpagealiases`). ## Properties ### aliases > **aliases**: `string`\[] Defined in: [core/query/siteinfo.ts:448](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L448) Aliases recognized for it in the content language. *** ### realname > **realname**: `string` Defined in: [core/query/siteinfo.ts:445](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L445) Canonical page name, e.g. `Ancientpages`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiStashEditResponse.md --- > 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: ApiStashEditResponse Defined in: [core/stashedit.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/stashedit.ts#L15) Response of `action=stashedit`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### stashedit > **stashedit**: `object` Defined in: [core/stashedit.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/stashedit.ts#L17) Result of `action=stashedit`. #### status > **status**: `string` & `object` | `"stashed"` | `"editconflict"` | `"ratelimited"` | `"busy"` | `"uncacheable"` | `"error_parse"` | `"error_cache"` Stash outcome: `stashed`, `editconflict` (merge3 failed), `ratelimited`, `busy`, `uncacheable`, `error_parse` or `error_cache`. Open union for forward compat. #### texthash? > `optional` **texthash?**: `string` Hash identifying the stashed text for a later `action=edit`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiStashImageInfo.md --- > 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: ApiStashImageInfo Defined in: [core/query/stashimageinfo.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L20) Metadata of one stashed file. ## Properties ### bitdepth? > `optional` **bitdepth?**: `number` Defined in: [core/query/stashimageinfo.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L49) Colour depth in bits. `siiprop=bitdepth`. *** ### canonicaltitle? > `optional` **canonicaltitle?**: `string` Defined in: [core/query/stashimageinfo.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L25) Canonical localized file title. `siiprop=canonicaltitle`. *** ### commonmetadata? > `optional` **commonmetadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] Defined in: [core/query/stashimageinfo.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L99) Metadata keys common to all file types, same item shape as [metadata](#metadata). `siiprop=commonmetadata`; an empty PHP map, so `[]` when there is none. *** ### descriptionshorturl? > `optional` **descriptionshorturl?**: `string` Defined in: [core/query/stashimageinfo.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L58) Shortened description-page URL. `siiprop=url`; only when the repo returns one. *** ### descriptionurl? > `optional` **descriptionurl?**: `string` Defined in: [core/query/stashimageinfo.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L55) URL of the file description page. `siiprop=url`; equals [url](#url) for a stashed file. *** ### duration? > `optional` **duration?**: `number` Defined in: [core/query/stashimageinfo.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L109) Media duration in seconds (audio/video), when the handler reports one. Emitted under `siiprop=size|dimensions`; there is no `siiprop=duration`. *** ### extmetadata? > `optional` **extmetadata?**: `Record`\<`string`, [`ApiExtMetadataField`](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataField.md)> Defined in: [core/query/stashimageinfo.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L102) Structured/extended metadata keyed by field name. `siiprop=extmetadata`. *** ### height? > `optional` **height?**: `number` Defined in: [core/query/stashimageinfo.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L31) Pixel height. `siiprop=size|dimensions`. *** ### metadata? > `optional` **metadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] | `null` Defined in: [core/query/stashimageinfo.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L92) Raw format metadata (EXIF / PNG chunks / …). `siiprop=metadata`; `null` when the file has none. *** ### mime? > `optional` **mime?**: `string` Defined in: [core/query/stashimageinfo.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L40) MIME type, e.g. `image/png`. `siiprop=mime`. *** ### pagecount? > `optional` **pagecount?**: `number` Defined in: [core/query/stashimageinfo.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L116) Page count (multi-page documents such as PDFs/TIFFs), when the handler supports one. Emitted under `siiprop=size|dimensions`; there is no `siiprop=pagecount`. *** ### responsiveUrls? > `optional` **responsiveUrls?**: `Record`\<`string`, `string`> Defined in: [core/query/stashimageinfo.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L79) HiDPI (`2x`, …) source URLs keyed by pixel-density multiplier. Requires `siiprop=url`, plus a successful transform. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/stashimageinfo.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L37) Content checksum (hex). `siiprop=sha1`. *** ### size? > `optional` **size?**: `number` Defined in: [core/query/stashimageinfo.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L28) Size in bytes. `siiprop=size|dimensions`. *** ### thumberror? > `optional` **thumberror?**: `string` Defined in: [core/query/stashimageinfo.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L86) Rendered text of the thumbnail error, when the requested thumbnail could not be made. Requires `siiprop=url`, plus a transform via `siiurlwidth`/`siiurlheight`/`siiurlparam`. *** ### thumbheight? > `optional` **thumbheight?**: `number` Defined in: [core/query/stashimageinfo.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L73) Scaled thumbnail height (px). Falls back to the file's own height like [thumbwidth](#thumbwidth). *** ### thumbmime? > `optional` **thumbmime?**: `string` Defined in: [core/query/stashimageinfo.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L46) MIME type the thumbnail will be rendered as. `siiprop=thumbmime`; requires `siiprop=url` and a transform via `siiurlwidth`/`siiurlheight`. *** ### thumburl? > `optional` **thumburl?**: `string` Defined in: [core/query/stashimageinfo.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L64) Scaled thumbnail URL. Requires `siiprop=url`, plus a transform requested via `siiurlwidth`, `siiurlheight` or `siiurlparam`. *** ### thumbwidth? > `optional` **thumbwidth?**: `number` Defined in: [core/query/stashimageinfo.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L70) Scaled thumbnail width (px). Falls back to the file's own width when no resize happened. Same requirements as [thumburl](#thumburl). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/stashimageinfo.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L22) When the file was stashed. `siiprop=timestamp`. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/stashimageinfo.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L52) Direct URL to the stashed file (an `Special:UploadStash/file/…` link). `siiprop=url`. *** ### width? > `optional` **width?**: `number` Defined in: [core/query/stashimageinfo.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/stashimageinfo.ts#L34) Pixel width. `siiprop=size|dimensions`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiStashedFile.md --- > 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: ApiStashedFile Defined in: [core/query/mystashedfiles.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L14) One stashed file. `msfprop` controls the measurement fields. ## Properties ### bits? > `optional` **bits?**: `number` Defined in: [core/query/mystashedfiles.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L34) Colour depth in bits. `msfprop=size`. *** ### filekey > **filekey**: `string` Defined in: [core/query/mystashedfiles.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L16) Handle to pass as `action=upload`'s `filekey`. *** ### height? > `optional` **height?**: `number` Defined in: [core/query/mystashedfiles.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L31) Image height; `0` for non-raster files. `msfprop=size`. *** ### mediatype? > `optional` **mediatype?**: `string` Defined in: [core/query/mystashedfiles.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L40) MediaWiki media bucket, e.g. `BITMAP`. `msfprop=type`. *** ### mimetype? > `optional` **mimetype?**: `string` Defined in: [core/query/mystashedfiles.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L37) Full MIME type, e.g. `image/png`. `msfprop=type`. *** ### size? > `optional` **size?**: `number` Defined in: [core/query/mystashedfiles.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L25) Stored size in bytes. `msfprop=size`. *** ### status > **status**: `string` & `object` | `"finished"` | `"chunks"` Defined in: [core/query/mystashedfiles.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L22) Stash state. `finished` once the whole file is stored; chunked uploads sit on `chunks` until assembled. Open union for other internal states. *** ### width? > `optional` **width?**: `number` Defined in: [core/query/mystashedfiles.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/mystashedfiles.ts#L28) Image width; `0` for non-raster files. `msfprop=size`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiTag.md --- > 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: ApiTag Defined in: [core/query/tags.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L11) One change-tag definition. `tgprop` selects the optional fields. ## Properties ### active? > `optional` **active?**: `boolean` Defined in: [core/query/tags.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L36) Whether the tag is still applicable. `tgprop=active`; a real `boolean`. *** ### defined? > `optional` **defined?**: `boolean` Defined in: [core/query/tags.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L25) Whether the tag has a definition page. `tgprop=defined`; a real `boolean`. *** ### description? > `optional` **description?**: `string` Defined in: [core/query/tags.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L19) Description (wikitext). `tgprop=description`. *** ### displayname? > `optional` **displayname?**: `string` Defined in: [core/query/tags.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L16) Human-readable display name (may contain HTML). `tgprop=displayname`. *** ### hitcount? > `optional` **hitcount?**: `number` Defined in: [core/query/tags.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L22) Number of revisions/logs carrying this tag. `tgprop=hitcount`. *** ### name > **name**: `string` Defined in: [core/query/tags.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L13) Internal tag name (used by `rcprop=tags` / revision `tags`). *** ### source? > `optional` **source?**: (`"extension"` | `"manual"` | `"software"`)\[] Defined in: [core/query/tags.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/tags.ts#L33) Where the tag can come from. `tgprop=source`: `software` for a tag defined in code, `manual` for one with a definition page, and `extension` as a backwards-compatibility entry emitted alongside `software`. Emitted as a list — a tag with no source serializes as `[]`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiTagEntry.md --- > 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: ApiTagEntry Defined in: [core/tag.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L17) One targeted entry of an `action=tag` response. ## Properties ### actionlogid? > `optional` **actionlogid?**: `number` Defined in: [core/tag.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L38) Log entry id recorded for the tagging (absent when [ApiTagEntry.noop](#noop)). *** ### added? > `optional` **added?**: `string`\[] Defined in: [core/tag.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L41) Tags added to this target. *** ### blockinfo? > `optional` **blockinfo?**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md) Defined in: [core/tag.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L84) Block details, when the performer is blocked from the target page. Under the default (`bc`) `errorformat` it is merged into the entry itself; a modern one nests it under [ApiTagEntry.data](#data). *** ### code? > `optional` **code?**: `string` Defined in: [core/tag.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L56) On `error` entries the formatted failure message is merged into the entry: `code` is the message's API code, and the text-bearing keys follow the request's `errorformat` — `info` under the default (`bc`) format, `text` (`plaintext`/`wikitext`), `html`, `key`/`params` (`raw`), or none of them for `none`. *** ### data? > `optional` **data?**: `object` Defined in: [core/tag.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L77) Structured message data, present under a modern `errorformat` (the default `bc` format merges it into the entry instead). #### Index Signature \[`key`: `string`]: `unknown` #### blockinfo? > `optional` **blockinfo?**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md) *** ### errors? > `optional` **errors?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/tag.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L47) In-band messages when the target could not be tagged (`failure` only), shaped per the request's `errorformat`. *** ### html? > `optional` **html?**: `string` Defined in: [core/tag.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L65) Parsed message HTML (`html`). *** ### info? > `optional` **info?**: `string` Defined in: [core/tag.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L59) Message text under the default (`bc`) `errorformat`. *** ### key? > `optional` **key?**: `string` Defined in: [core/tag.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L68) i18n message key (`raw`). *** ### logid? > `optional` **logid?**: `number` Defined in: [core/tag.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L22) Log id the tags were applied to. *** ### noop? > `optional` **noop?**: `true` Defined in: [core/tag.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L35) The tag set already matched — no log entry was created. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### params? > `optional` **params?**: [`ApiMessageParam`](https://types-mediawiki-response.pages.dev/api/core/ApiMessageParam.md)\[] Defined in: [core/tag.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L71) i18n message parameters (`raw`). *** ### rcid? > `optional` **rcid?**: `number` Defined in: [core/tag.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L25) Recent-change id the tags were applied to. *** ### removed? > `optional` **removed?**: `string`\[] Defined in: [core/tag.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L44) Tags removed from this target. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/tag.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L19) Revision id the tags were applied to. *** ### status > **status**: `string` & `object` | `"error"` | `"success"` | `"failure"` | `"skipped"` Defined in: [core/tag.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L32) Per-target outcome: `success`, `failure`, `skipped` (rate throttle) or `error` (invalid target id, or the performer is blocked from the target page). Open union for forward compat. *** ### text? > `optional` **text?**: `string` Defined in: [core/tag.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L62) Rendered message text (`plaintext`/`wikitext`). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiTagResponse.md --- > 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: ApiTagResponse Defined in: [core/tag.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L88) Response of `action=tag`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### tag > **tag**: [`ApiTagEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiTagEntry.md)\[] Defined in: [core/tag.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/tag.ts#L90) Result of `action=tag`; one entry per targeted revision, recent-change entry or log entry. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiTemplate.md --- > 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: ApiTemplate Defined in: [core/query/templates.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/templates.ts#L10) One page transcluded by the subject page. ## Properties ### ns > **ns**: `number` Defined in: [core/query/templates.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/templates.ts#L12) Namespace index of the transcluded page. *** ### title > **title**: `string` Defined in: [core/query/templates.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/templates.ts#L15) Title of the transcluded page. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiThumbUrlEntry.md --- > 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: ApiThumbUrlEntry Defined in: [core/query/imageinfo.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L59) One scaled thumbnail entry (a keyed value of [ApiImageInfo.thumburls](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburls)). ## Indexable > \[`attribute`: `string`]: `string` | `number` | `undefined` Additional pre-rendered `` attributes merged by the transform (typically `src`, `decoding` and `loading`, plus `srcset` when HiDPI variants exist), same shape as [ApiImageInfo.thumbattribs](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbattribs). ## Properties ### height? > `optional` **height?**: `number` Defined in: [core/query/imageinfo.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L67) Rendered height in pixels. *** ### url? > `optional` **url?**: `string` Defined in: [core/query/imageinfo.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L61) Thumbnail source URL. *** ### width? > `optional` **width?**: `number` Defined in: [core/query/imageinfo.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L64) Rendered width in pixels. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiTrackingCategory.md --- > 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: ApiTrackingCategory Defined in: [core/query/trackingcategories.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/trackingcategories.ts#L11) One tracking-category entry. `tcprop=size|hidden` controls the size fields. ## Extends - [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md) ## Properties ### category > **category**: `string` Defined in: [core/query/allcategories.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L11) Category name, without the `Category:` prefix. #### Inherited from [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md).[`category`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md#category) *** ### catid > **catid**: `string` Defined in: [core/query/trackingcategories.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/trackingcategories.ts#L13) Message key of the tracking category (e.g. `broken-file-category`). *** ### files? > `optional` **files?**: `number` Defined in: [core/query/allcategories.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L20) Number of files. `acprop=size`. #### Inherited from [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md).[`files`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md#files) *** ### hidden? > `optional` **hidden?**: `boolean` Defined in: [core/query/allcategories.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L26) Whether the category is hidden. `acprop=hidden`; a real `boolean`. #### Inherited from [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md).[`hidden`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md#hidden) *** ### pages? > `optional` **pages?**: `number` Defined in: [core/query/allcategories.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L17) Number of pages. `acprop=size`. #### Inherited from [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md).[`pages`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md#pages) *** ### size? > `optional` **size?**: `number` Defined in: [core/query/allcategories.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L14) Total members (pages + subcats + files). `acprop=size`. #### Inherited from [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md).[`size`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md#size) *** ### subcats? > `optional` **subcats?**: `number` Defined in: [core/query/allcategories.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/allcategories.ts#L23) Number of subcategories. `acprop=size`. #### Inherited from [`ApiAllCategory`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md).[`subcats`](https://types-mediawiki-response.pages.dev/api/core/ApiAllCategory.md#subcats) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiTranscludedIn.md --- > 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: ApiTranscludedIn Defined in: [core/query/transcludedin.ts:11](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/transcludedin.ts#L11) One page in a `transcludedin` result. `tiprop` controls which fields appear. ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [core/query/transcludedin.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/transcludedin.ts#L16) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/transcludedin.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/transcludedin.ts#L13) Page id. `tiprop=pageid`. *** ### redirect? > `optional` **redirect?**: `boolean` Defined in: [core/query/transcludedin.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/transcludedin.ts#L22) Whether the transcluding page is a redirect. `tiprop=redirect`; a real `boolean`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/transcludedin.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/transcludedin.ts#L19) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResponse.md --- > 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: ApiUnblockResponse Defined in: [core/unblock.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L38) Response of `action=unblock`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### unblock > **unblock**: [`ApiUnblockResult`](https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResult.md) Defined in: [core/unblock.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L40) Result of `action=unblock`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUnblockResult.md --- > 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: ApiUnblockResult Defined in: [core/unblock.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L14) The `unblock` object of an `action=unblock` response. ## Properties ### id > **id**: `number` Defined in: [core/unblock.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L16) Removed block id. *** ### reason > **reason**: `string` Defined in: [core/unblock.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L25) Unblock reason (echoed back). *** ### user > **user**: `string` Defined in: [core/unblock.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L19) Unblocked user name / IP; empty string when removing an autoblock. *** ### userid > **userid**: `number` Defined in: [core/unblock.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L22) Unblocked user id (`0` for IPs and autoblocks). Note lowercase, unlike the block result. *** ### watchlistexpiry? > `optional` **watchlistexpiry?**: [`WatchlistExpiry`](https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md) Defined in: [core/unblock.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L34) Expiry applied to the watched user page, present only when `watchuser=1` took effect. *** ### watchuser > **watchuser**: `boolean` Defined in: [core/unblock.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/unblock.ts#L28) Whether the unblock added the unblocked user to the unblocker's watchlist. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResponse.md --- > 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: ApiUndeleteResponse Defined in: [core/undelete.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L25) Response of `action=undelete`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### undelete > **undelete**: [`ApiUndeleteResult`](https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResult.md) Defined in: [core/undelete.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L27) Result of `action=undelete`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUndeleteResult.md --- > 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: ApiUndeleteResult Defined in: [core/undelete.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L10) The `undelete` object of an `action=undelete` response. ## Properties ### fileversions > **fileversions**: `number` Defined in: [core/undelete.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L18) Number of file versions restored. *** ### reason > **reason**: `string` Defined in: [core/undelete.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L21) Undelete reason (echoed back). *** ### revisions > **revisions**: `number` Defined in: [core/undelete.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L15) Number of revisions restored. *** ### title > **title**: `string` Defined in: [core/undelete.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/undelete.ts#L12) Restored page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUploadDialog.md --- > 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: ApiUploadDialog Defined in: [core/query/siteinfo.ts:717](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L717) Upload dialog configuration (`siprop=uploaddialog`), mirroring `$wgUploadDialog` verbatim. ## Properties ### comment? > `optional` **comment?**: `string` | \{ `foreign?`: `string`; `local?`: `string`; } Defined in: [core/query/siteinfo.ts:743](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L743) Default edit summaries, per upload target (`local`/`foreign`), or a single string on wikis that configure one. `$PAGENAME` and `$HOST` are substituted. #### Union Members `string` *** ##### Type Literal \{ `foreign?`: `string`; `local?`: `string`; } ##### foreign? > `optional` **foreign?**: `string` Used when the target is a foreign repo. ##### local? > `optional` **local?**: `string` Used when the target is this wiki. *** ### fields? > `optional` **fields?**: `object` Defined in: [core/query/siteinfo.ts:719](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L719) Which extra form fields are shown. Keys are absent when not applicable. #### categories? > `optional` **categories?**: `boolean` The categories field. #### date? > `optional` **date?**: `boolean` The date field. #### description? > `optional` **description?**: `boolean` The free-form description field. *** ### format? > `optional` **format?**: `object` Defined in: [core/query/siteinfo.ts:754](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L754) Templates/placeholder text used to build the file page. #### description? > `optional` **description?**: `string` Template for one description, with `$LANGUAGE` and `$TEXT` substituted. #### filepage? > `optional` **filepage?**: `string` File page wikitext, with `$DESCRIPTION`, `$DATE`, `$SOURCE`, `$AUTHOR`, `$LICENSE` and `$CATEGORIES` substituted. #### license? > `optional` **license?**: `string` Wikitext for the chosen license. #### ownwork? > `optional` **ownwork?**: `string` Source wikitext used when the uploader declares the work as their own. #### uncategorized? > `optional` **uncategorized?**: `string` Wikitext used instead of category links when no categories are given. *** ### licensemessages? > `optional` **licensemessages?**: `object` Defined in: [core/query/siteinfo.ts:731](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L731) Message keys for the license selectors, per upload target. #### foreign? > `optional` **foreign?**: `string` Used when the target is a foreign repo. #### local? > `optional` **local?**: `string` Used when the target is this wiki. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUploadExtMetadataField.md --- > 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: ApiUploadExtMetadataField Defined in: [core/upload.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L19) A single `extmetadata` field on an uploaded file's imageinfo. ## Properties ### hidden? > `optional` **hidden?**: `string` Defined in: [core/upload.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L27) Empty string marking the field as hidden from default display. *** ### source? > `optional` **source?**: `string` Defined in: [core/upload.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L24) Where the value came from (e.g. `mediawiki-metadata`, `exif`). *** ### value? > `optional` **value?**: `string` Defined in: [core/upload.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L21) Field value (usually a string; may be a timestamp or HTML). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUploadImageinfo.md --- > 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: ApiUploadImageinfo Defined in: [core/upload.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L40) The embedded `imageinfo` of an `action=upload` result, for the uploaded revision. ## Properties ### bitdepth? > `optional` **bitdepth?**: `number` Defined in: [core/upload.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L75) Color bit depth, for images that report one. *** ### canonicaltitle? > `optional` **canonicaltitle?**: `string` Defined in: [core/upload.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L78) Canonical localized file title. *** ### comment? > `optional` **comment?**: `string` Defined in: [core/upload.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L51) Raw upload comment. *** ### commonmetadata? > `optional` **commonmetadata?**: [`ApiUploadMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadMetadataItem.md)\[] Defined in: [core/upload.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L93) Metadata shared across the file's revisions. *** ### descriptionurl? > `optional` **descriptionurl?**: `string` Defined in: [core/upload.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L84) URL of the file description page. *** ### extmetadata? > `optional` **extmetadata?**: `Record`\<`string`, [`ApiUploadExtMetadataField`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadExtMetadataField.md)> Defined in: [core/upload.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L96) Extended metadata (EXIF and similar), keyed by field name. *** ### height? > `optional` **height?**: `number` Defined in: [core/upload.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L63) Height in pixels; `0` for files without dimensions (e.g. audio). *** ### html? > `optional` **html?**: `string` Defined in: [core/upload.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L87) Exists-warning HTML from `Special:Upload` (`iiprop=uploadwarning`). *** ### mediatype? > `optional` **mediatype?**: `string` Defined in: [core/upload.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L72) MediaWiki media type classification. *** ### metadata? > `optional` **metadata?**: [`ApiUploadMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadMetadataItem.md)\[] Defined in: [core/upload.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L90) Per-file metadata as `{ name, value }` entries. *** ### mime? > `optional` **mime?**: `string` Defined in: [core/upload.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L69) Detected MIME type. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/upload.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L54) HTML-rendered upload comment. *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/upload.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L66) SHA-1 of the file contents. *** ### size? > `optional` **size?**: `number` Defined in: [core/upload.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L57) File size in bytes. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/upload.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L42) Upload timestamp of the new file. *** ### url? > `optional` **url?**: `string` Defined in: [core/upload.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L81) Direct URL to the file. *** ### user? > `optional` **user?**: `string` Defined in: [core/upload.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L45) Uploader user name. *** ### userid? > `optional` **userid?**: `number` Defined in: [core/upload.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L48) Uploader user id. *** ### width? > `optional` **width?**: `number` Defined in: [core/upload.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L60) Width in pixels; `0` for files without dimensions (e.g. audio). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUploadMetadataItem.md --- > 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: ApiUploadMetadataItem Defined in: [core/upload.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L31) One `{ name, value }` metadata entry (values nest for structured types). ## Properties ### name? > `optional` **name?**: `string` Defined in: [core/upload.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L33) Field label, e.g. `frameCount`. *** ### value? > `optional` **value?**: `unknown` Defined in: [core/upload.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L36) Field value; a list of further entries when the format groups fields. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUploadResponse.md --- > 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: ApiUploadResponse Defined in: [core/upload.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L112) Response of `action=upload`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### upload > **upload**: `object` Defined in: [core/upload.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L114) Result of `action=upload`. #### filekey? > `optional` **filekey?**: `string` File key when the upload was stashed (`stash=1`) or published from a stash. #### filename? > `optional` **filename?**: `string` Stored file name (spaces underscored). #### imageinfo? > `optional` **imageinfo?**: [`ApiUploadImageinfo`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadImageinfo.md) Imageinfo for the newly stored revision (added only on `Success`). #### offset? > `optional` **offset?**: `number` Chunked-upload byte offset (present on `Continue` results). #### result > **result**: `string` & `object` | `"Success"` | `"Failure"` | `"Warning"` | `"Poll"` | `"Continue"` Outcome of the upload, set by the result builders (`getStashResult`, `getWarningsResult`, `getChunkResult`, `performUpload`). #### sessionkey? > `optional` **sessionkey?**: `string` Session key mirroring `filekey` on a stashed upload. #### stage? > `optional` **stage?**: `string` & `object` | `"queued"` | `"uploading"` | `"assembling"` Async/chunked stage (present on `Poll`/`Continue` results). #### warnings? > `optional` **warnings?**: [`ApiUploadWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadWarnings.md) Recoverable warnings (distinct from the envelope `warnings`). *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUploadWarnings.md --- > 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: ApiUploadWarnings Defined in: [core/upload.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L100) In-band upload warnings (values are strings, string arrays, or objects). ## Indexable > \[`warning`: `string`]: `unknown` Per-warning detail (bad-filetype, others, …). ## Properties ### duplicate? > `optional` **duplicate?**: `string`\[] Defined in: [core/upload.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L102) Files sharing the same sha1. *** ### duplicate-archive? > `optional` **duplicate-archive?**: `string` Defined in: [core/upload.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L104) Name of a previously deleted file with the same sha1 (`""` when its content is hidden). *** ### exists? > `optional` **exists?**: `string` Defined in: [core/upload.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L106) The target exists; the upload was applied anyway when `ignorewarnings` set. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUsedImage.md --- > 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: ApiUsedImage Defined in: [core/query/images.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/images.ts#L10) One image used by a page. ## Properties ### ns > **ns**: `number` Defined in: [core/query/images.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/images.ts#L12) Namespace index (the File namespace). *** ### title > **title**: `string` Defined in: [core/query/images.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/images.ts#L15) Full file title, e.g. `File:Example.png`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUser.md --- > 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: ApiUser Defined in: [core/query/users.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L135) A user record. `usprop` controls which fields appear. ## Extends - [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md) ## Properties ### attachedlocal? > `optional` **attachedlocal?**: `Record`\<`string`, `boolean`> Defined in: [core/query/users.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L131) Whether the account is attached to each provider, keyed like [centralids](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#centralids). `usprop=centralids` / `uiprop=centralids`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`attachedlocal`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#attachedlocal) *** ### blockanononly? > `optional` **blockanononly?**: `boolean` Defined in: [core/query/users.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L52) Whether the block only affects anonymous users (soft block). A real `boolean`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockanononly`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockanononly) *** ### blockautoblocking? > `optional` **blockautoblocking?**: `boolean` Defined in: [core/query/users.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L83) Whether the block also enables the autoblock feature. A real `boolean`. #### Since MediaWiki 1.46 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockautoblocking`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockautoblocking) *** ### blockcomponents? > `optional` **blockcomponents?**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md)\[] Defined in: [core/query/users.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L76) The individual blocks composing this one; only for composite blocks. #### Since MediaWiki 1.42 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockcomponents`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockcomponents) *** ### blockedby? > `optional` **blockedby?**: `string` Defined in: [core/query/users.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L20) User name of the blocker; `''` when unknown (e.g. autoblocks). #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedby`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedby) *** ### blockedbyid? > `optional` **blockedbyid?**: `number` Defined in: [core/query/users.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L23) User id of the blocker; `0` when unknown. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedbyid`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedbyid) *** ### blockedtimestamp? > `optional` **blockedtimestamp?**: `string` Defined in: [core/query/users.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L29) When the block was placed or last modified. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedtimestamp) *** ### blockedtimestampformatted? > `optional` **blockedtimestampformatted?**: `string` Defined in: [core/query/users.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L34) `blockedtimestamp` localized for the requesting user. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedtimestampformatted`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedtimestampformatted) *** ### blockemail? > `optional` **blockemail?**: `boolean` Defined in: [core/query/users.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L59) Whether the block prevents sending email. A real `boolean`. #### Since MediaWiki 1.41 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockemail`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockemail) *** ### blockexpiry? > `optional` **blockexpiry?**: `string` Defined in: [core/query/users.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L37) Block expiry; the literal `infinite` when the block does not expire. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockexpiry`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockexpiry) *** ### blockexpiryformatted? > `optional` **blockexpiryformatted?**: `string` Defined in: [core/query/users.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L40) `blockexpiry` localized for the requesting user; only when the block expires. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockexpiryformatted`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockexpiryformatted) *** ### blockexpiryrelative? > `optional` **blockexpiryrelative?**: `string` Defined in: [core/query/users.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L43) Human-readable time to expiry (e.g. `in 5 days`); only when the block expires. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockexpiryrelative`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockexpiryrelative) *** ### blockhidden? > `optional` **blockhidden?**: `true` Defined in: [core/query/users.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L91) The block itself is suppressed (hidden from users without the `hideuser` right). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md), present only when suppressed. #### Since MediaWiki 1.47 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockhidden) *** ### blockid? > `optional` **blockid?**: `number` Defined in: [core/query/users.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L17) ID of the block. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockid`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockid) *** ### blocknocreate? > `optional` **blocknocreate?**: `boolean` Defined in: [core/query/users.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L49) Whether the block prevents account creation. A real `boolean`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blocknocreate`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blocknocreate) *** ### blockowntalk? > `optional` **blockowntalk?**: `boolean` Defined in: [core/query/users.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L66) Whether editing one's own talk page is prevented. A real `boolean`. #### Since MediaWiki 1.41 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockowntalk`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockowntalk) *** ### blockpartial? > `optional` **blockpartial?**: `boolean` Defined in: [core/query/users.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L46) Whether the block only applies to certain pages, namespaces and/or actions. A real `boolean`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockpartial`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockpartial) *** ### blockreason? > `optional` **blockreason?**: `string` Defined in: [core/query/users.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L26) Block reason, in plain text. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockreason`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockreason) *** ### cancreate? > `optional` **cancreate?**: `boolean` Defined in: [core/query/users.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L171) Whether an account could be created for this name. `usprop=cancreate`; a real `boolean`, present only on `missing` entries queried by name. *** ### cancreateerror? > `optional` **cancreateerror?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/query/users.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L177) Why [cancreate](#cancreate) is `false` (e.g. a reserved username), shaped per the request's `errorformat`. Emitted only when the creation check failed. *** ### centralids? > `optional` **centralids?**: `Record`\<`string`, `number`> Defined in: [core/query/users.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L128) Global (CentralAuth) ids keyed by provider. `usprop=centralids` / `uiprop=centralids`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`centralids`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#centralids) *** ### editcount? > `optional` **editcount?**: `number` Defined in: [core/query/users.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L113) Total edit count. `usprop=editcount` / `uiprop=editcount`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`editcount`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#editcount) *** ### emailable? > `optional` **emailable?**: `boolean` Defined in: [core/query/users.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L165) Whether the user can be emailed. `usprop=emailable`; a real `boolean` (`false` when the address is hidden or unconfirmed), not a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### gender? > `optional` **gender?**: `string` & `object` | `"unknown"` | `"male"` | `"female"` Defined in: [core/query/users.ts:159](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L159) User gender. `usprop=gender`. Open union for forward compatibility. *** ### groupmemberships? > `optional` **groupmemberships?**: [`ApiUserGroupMembership`](https://types-mediawiki-response.pages.dev/api/core/ApiUserGroupMembership.md)\[] Defined in: [core/query/users.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L119) Group memberships with grant/expiry metadata. `usprop=groupmemberships` / `uiprop=groupmemberships`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`groupmemberships`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#groupmemberships) *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [core/query/users.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L116) Groups the user belongs to (including implicit). `usprop=groups` / `uiprop=groups`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`groups`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#groups) *** ### hidden? > `optional` **hidden?**: `true` Defined in: [core/query/users.ts:183](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L183) The user is hidden (suppressed via a hidden block); a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Emitted regardless of `usprop`. *** ### implicitgroups? > `optional` **implicitgroups?**: `string`\[] Defined in: [core/query/users.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L122) Groups that apply by virtue of an inherent right, not membership. `usprop=implicitgroups` / `uiprop=implicitgroups`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`implicitgroups`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#implicitgroups) *** ### missing? > `optional` **missing?**: `true` Defined in: [core/query/users.ts:150](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L150) `true` when no such user exists (`missing` is a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md)). *** ### name? > `optional` **name?**: `string` Defined in: [core/query/users.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L140) User name (normalized). Present on found entries and on `missing` entries queried by name; absent from `missing` entries queried by `ususerids`. *** ### registration? > `optional` **registration?**: `string` | `null` Defined in: [core/query/users.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L156) Registration timestamp. `null` for accounts created before registration timestamps were tracked. `usprop=registration`. *** ### rights? > `optional` **rights?**: `string`\[] Defined in: [core/query/users.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L125) Effective rights. `usprop=rights` / `uiprop=rights`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`rights`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#rights) *** ### systemblocktype? > `optional` **systemblocktype?**: `string` Defined in: [core/query/users.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L69) Type of the automatically applied system block; only for system blocks. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`systemblocktype`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#systemblocktype) *** ### systemuser? > `optional` **systemuser?**: `true` Defined in: [core/query/users.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L191) `true` when this is a system user (e.g. `MediaWiki default`), absent otherwise; not gated by any `usprop`. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.43 *** ### tempexpired? > `optional` **tempexpired?**: `boolean` | `null` Defined in: [core/query/users.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L200) Whether a temporary account has expired. `usprop=tempexpired` (`auprop=tempexpired` for `list=allusers`); a real `boolean` for a temporary account, and `null` for any other user. #### Since MediaWiki 1.46 *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/users.ts:147](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L147) User id. Present on found entries, and on `missing` entries queried by `ususerids` (echoing the requested id); absent from name-queried `missing` entries. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUserContrib.md --- > 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: ApiUserContrib Defined in: [core/query/usercontribs.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L14) One contribution record. `ucprop` controls which fields appear. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### autopatrolled? > `optional` **autopatrolled?**: `boolean` Defined in: [core/query/usercontribs.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L64) Whether the change was auto-patrolled via the user's rights. `ucprop=patrolled`; a real `boolean`. *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/usercontribs.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L49) Raw edit summary. `ucprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/usercontribs.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L79) The summary is hidden. `ucprop=comment|parsedcomment`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Overrides [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### minor? > `optional` **minor?**: `boolean` Defined in: [core/query/usercontribs.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L43) Whether the edit was minor. `ucprop=flags`; a real `boolean`. *** ### new? > `optional` **new?**: `boolean` Defined in: [core/query/usercontribs.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L40) Whether this created a new page. `ucprop=flags`; a real `boolean`. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/usercontribs.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L31) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/usercontribs.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L22) Id of the edited page. `ucprop=ids`. *** ### parentid? > `optional` **parentid?**: `number` Defined in: [core/query/usercontribs.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L28) Previous revision id; `0` for a new page. `ucprop=ids`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/usercontribs.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L52) HTML-rendered edit summary. `ucprop=parsedcomment`. *** ### patrolled? > `optional` **patrolled?**: `boolean` Defined in: [core/query/usercontribs.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L58) Whether the change has been patrolled. `ucprop=patrolled` (only for a caller that may see patrol state); a real `boolean`, present as `false` too. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/usercontribs.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L25) Revision id of this contribution. `ucprop=ids`. *** ### size? > `optional` **size?**: `number` Defined in: [core/query/usercontribs.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L67) Revision size in bytes. `ucprop=size`. *** ### sizediff? > `optional` **sizediff?**: `number` Defined in: [core/query/usercontribs.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L70) Change in bytes vs. the parent. `ucprop=sizediff`. *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [core/query/usercontribs.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L73) Change tags. `ucprop=tags`. *** ### texthidden? > `optional` **texthidden?**: `true` Defined in: [core/query/usercontribs.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L76) The revision content is hidden (revision-deleted). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/usercontribs.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L37) Contribution timestamp. `ucprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/usercontribs.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L34) Title of the edited page. *** ### top? > `optional` **top?**: `boolean` Defined in: [core/query/usercontribs.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L46) Whether this is the current revision. `ucprop=flags`; a real `boolean`. *** ### user > **user**: `string` Defined in: [core/query/usercontribs.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L19) Author user name or IP. Not gated by `ucprop`. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid > **userid**: `number` Defined in: [core/query/usercontribs.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/usercontribs.ts#L16) Author user id; `0` for anonymous editors. Not gated by `ucprop`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md --- > 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: ApiUserCore Defined in: [core/query/users.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L111) Fields present on both the `list=users` ([ApiUser](https://types-mediawiki-response.pages.dev/api/core/ApiUser.md)) and `meta=userinfo` user records; each is gated by the same `usprop`/`uiprop` value in both modules. ## Extends - [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md) ## Extended by - [`ApiUser`](https://types-mediawiki-response.pages.dev/api/core/ApiUser.md) - [`ApiUserInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiUserInfo.md) ## Properties ### attachedlocal? > `optional` **attachedlocal?**: `Record`\<`string`, `boolean`> Defined in: [core/query/users.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L131) Whether the account is attached to each provider, keyed like [centralids](#centralids). `usprop=centralids` / `uiprop=centralids`. *** ### blockanononly? > `optional` **blockanononly?**: `boolean` Defined in: [core/query/users.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L52) Whether the block only affects anonymous users (soft block). A real `boolean`. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockanononly`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockanononly) *** ### blockautoblocking? > `optional` **blockautoblocking?**: `boolean` Defined in: [core/query/users.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L83) Whether the block also enables the autoblock feature. A real `boolean`. #### Since MediaWiki 1.46 #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockautoblocking`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockautoblocking) *** ### blockcomponents? > `optional` **blockcomponents?**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md)\[] Defined in: [core/query/users.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L76) The individual blocks composing this one; only for composite blocks. #### Since MediaWiki 1.42 #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockcomponents`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockcomponents) *** ### blockedby? > `optional` **blockedby?**: `string` Defined in: [core/query/users.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L20) User name of the blocker; `''` when unknown (e.g. autoblocks). #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockedby`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockedby) *** ### blockedbyid? > `optional` **blockedbyid?**: `number` Defined in: [core/query/users.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L23) User id of the blocker; `0` when unknown. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockedbyid`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockedbyid) *** ### blockedtimestamp? > `optional` **blockedtimestamp?**: `string` Defined in: [core/query/users.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L29) When the block was placed or last modified. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockedtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockedtimestamp) *** ### blockedtimestampformatted? > `optional` **blockedtimestampformatted?**: `string` Defined in: [core/query/users.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L34) `blockedtimestamp` localized for the requesting user. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockedtimestampformatted`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockedtimestampformatted) *** ### blockemail? > `optional` **blockemail?**: `boolean` Defined in: [core/query/users.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L59) Whether the block prevents sending email. A real `boolean`. #### Since MediaWiki 1.41 #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockemail`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockemail) *** ### blockexpiry? > `optional` **blockexpiry?**: `string` Defined in: [core/query/users.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L37) Block expiry; the literal `infinite` when the block does not expire. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockexpiry`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockexpiry) *** ### blockexpiryformatted? > `optional` **blockexpiryformatted?**: `string` Defined in: [core/query/users.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L40) `blockexpiry` localized for the requesting user; only when the block expires. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockexpiryformatted`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockexpiryformatted) *** ### blockexpiryrelative? > `optional` **blockexpiryrelative?**: `string` Defined in: [core/query/users.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L43) Human-readable time to expiry (e.g. `in 5 days`); only when the block expires. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockexpiryrelative`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockexpiryrelative) *** ### blockhidden? > `optional` **blockhidden?**: `true` Defined in: [core/query/users.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L91) The block itself is suppressed (hidden from users without the `hideuser` right). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md), present only when suppressed. #### Since MediaWiki 1.47 #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockhidden) *** ### blockid? > `optional` **blockid?**: `number` Defined in: [core/query/users.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L17) ID of the block. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockid`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockid) *** ### blocknocreate? > `optional` **blocknocreate?**: `boolean` Defined in: [core/query/users.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L49) Whether the block prevents account creation. A real `boolean`. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blocknocreate`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blocknocreate) *** ### blockowntalk? > `optional` **blockowntalk?**: `boolean` Defined in: [core/query/users.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L66) Whether editing one's own talk page is prevented. A real `boolean`. #### Since MediaWiki 1.41 #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockowntalk`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockowntalk) *** ### blockpartial? > `optional` **blockpartial?**: `boolean` Defined in: [core/query/users.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L46) Whether the block only applies to certain pages, namespaces and/or actions. A real `boolean`. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockpartial`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockpartial) *** ### blockreason? > `optional` **blockreason?**: `string` Defined in: [core/query/users.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L26) Block reason, in plain text. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`blockreason`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#blockreason) *** ### centralids? > `optional` **centralids?**: `Record`\<`string`, `number`> Defined in: [core/query/users.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L128) Global (CentralAuth) ids keyed by provider. `usprop=centralids` / `uiprop=centralids`. *** ### editcount? > `optional` **editcount?**: `number` Defined in: [core/query/users.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L113) Total edit count. `usprop=editcount` / `uiprop=editcount`. *** ### groupmemberships? > `optional` **groupmemberships?**: [`ApiUserGroupMembership`](https://types-mediawiki-response.pages.dev/api/core/ApiUserGroupMembership.md)\[] Defined in: [core/query/users.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L119) Group memberships with grant/expiry metadata. `usprop=groupmemberships` / `uiprop=groupmemberships`. *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [core/query/users.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L116) Groups the user belongs to (including implicit). `usprop=groups` / `uiprop=groups`. *** ### implicitgroups? > `optional` **implicitgroups?**: `string`\[] Defined in: [core/query/users.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L122) Groups that apply by virtue of an inherent right, not membership. `usprop=implicitgroups` / `uiprop=implicitgroups`. *** ### rights? > `optional` **rights?**: `string`\[] Defined in: [core/query/users.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L125) Effective rights. `usprop=rights` / `uiprop=rights`. *** ### systemblocktype? > `optional` **systemblocktype?**: `string` Defined in: [core/query/users.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L69) Type of the automatically applied system block; only for system blocks. #### Inherited from [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md).[`systemblocktype`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md#systemblocktype) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUserGroup.md --- > 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: ApiUserGroup Defined in: [core/query/siteinfo.ts:382](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L382) One user group (`siprop=usergroups`). The right-granting lists come from `$wgAddGroups`/`$wgRemoveGroups`/…, so they are absent when unconfigured. ## Properties ### add? > `optional` **add?**: `string`\[] Defined in: [core/query/siteinfo.ts:393](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L393) Groups an admin may add this group to. *** ### add-self? > `optional` **add-self?**: `string`\[] Defined in: [core/query/siteinfo.ts:399](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L399) Groups a user may grant to themselves. *** ### name > **name**: `string` Defined in: [core/query/siteinfo.ts:384](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L384) Group key; `*` is the anonymous group. *** ### number? > `optional` **number?**: `number` Defined in: [core/query/siteinfo.ts:390](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L390) Member count. Only with `sinumberingroup`; absent for `*` and autopromote groups. *** ### remove? > `optional` **remove?**: `string`\[] Defined in: [core/query/siteinfo.ts:396](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L396) Groups an admin may remove this group from. *** ### remove-self? > `optional` **remove-self?**: `string`\[] Defined in: [core/query/siteinfo.ts:402](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L402) Groups a user may revoke from themselves. *** ### rights > **rights**: `string`\[] Defined in: [core/query/siteinfo.ts:387](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L387) Rights granted by the group. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUserGroupMembership.md --- > 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: ApiUserGroupMembership Defined in: [core/query/users.ts:98](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L98) A single group membership with grant metadata. `usprop=groupmemberships` (vs. the plain name list from `usprop=groups`). ## Properties ### expiry? > `optional` **expiry?**: `string` Defined in: [core/query/users.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L103) When the membership expires: a timestamp, or `infinity` when permanent. *** ### group? > `optional` **group?**: `string` Defined in: [core/query/users.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L100) Group key, e.g. `sysop`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUserInfo.md --- > 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: ApiUserInfo Defined in: [core/query/userinfo.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L35) The `userinfo` object of a `meta=userinfo` response. ## Extends - [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md) ## Properties ### acceptlang? > `optional` **acceptlang?**: [`ApiAcceptLang`](https://types-mediawiki-response.pages.dev/api/core/ApiAcceptLang.md)\[] Defined in: [core/query/userinfo.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L113) Parsed `Accept-Language`. `uiprop=acceptlang`. *** ### anon? > `optional` **anon?**: `true` Defined in: [core/query/userinfo.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L43) `true` for an anonymous (IP) session. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### attachedlocal? > `optional` **attachedlocal?**: `Record`\<`string`, `boolean`> Defined in: [core/query/users.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L131) Whether the account is attached to each provider, keyed like [centralids](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#centralids). `usprop=centralids` / `uiprop=centralids`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`attachedlocal`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#attachedlocal) *** ### attachedwiki? > `optional` **attachedwiki?**: `Record`\<`string`, `boolean`> Defined in: [core/query/userinfo.ts:150](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L150) Whether the user is attached on the wiki named by the `attachedwiki` parameter, keyed by provider. Requires `uiprop=centralids` together with the `attachedwiki` parameter. *** ### blockanononly? > `optional` **blockanononly?**: `boolean` Defined in: [core/query/users.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L52) Whether the block only affects anonymous users (soft block). A real `boolean`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockanononly`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockanononly) *** ### blockautoblocking? > `optional` **blockautoblocking?**: `boolean` Defined in: [core/query/users.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L83) Whether the block also enables the autoblock feature. A real `boolean`. #### Since MediaWiki 1.46 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockautoblocking`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockautoblocking) *** ### blockcomponents? > `optional` **blockcomponents?**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md)\[] Defined in: [core/query/users.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L76) The individual blocks composing this one; only for composite blocks. #### Since MediaWiki 1.42 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockcomponents`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockcomponents) *** ### blockedby? > `optional` **blockedby?**: `string` Defined in: [core/query/users.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L20) User name of the blocker; `''` when unknown (e.g. autoblocks). #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedby`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedby) *** ### blockedbyid? > `optional` **blockedbyid?**: `number` Defined in: [core/query/users.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L23) User id of the blocker; `0` when unknown. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedbyid`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedbyid) *** ### blockedtimestamp? > `optional` **blockedtimestamp?**: `string` Defined in: [core/query/users.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L29) When the block was placed or last modified. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedtimestamp) *** ### blockedtimestampformatted? > `optional` **blockedtimestampformatted?**: `string` Defined in: [core/query/users.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L34) `blockedtimestamp` localized for the requesting user. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockedtimestampformatted`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockedtimestampformatted) *** ### blockemail? > `optional` **blockemail?**: `boolean` Defined in: [core/query/users.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L59) Whether the block prevents sending email. A real `boolean`. #### Since MediaWiki 1.41 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockemail`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockemail) *** ### blockexpiry? > `optional` **blockexpiry?**: `string` Defined in: [core/query/users.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L37) Block expiry; the literal `infinite` when the block does not expire. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockexpiry`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockexpiry) *** ### blockexpiryformatted? > `optional` **blockexpiryformatted?**: `string` Defined in: [core/query/users.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L40) `blockexpiry` localized for the requesting user; only when the block expires. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockexpiryformatted`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockexpiryformatted) *** ### blockexpiryrelative? > `optional` **blockexpiryrelative?**: `string` Defined in: [core/query/users.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L43) Human-readable time to expiry (e.g. `in 5 days`); only when the block expires. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockexpiryrelative`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockexpiryrelative) *** ### blockhidden? > `optional` **blockhidden?**: `true` Defined in: [core/query/users.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L91) The block itself is suppressed (hidden from users without the `hideuser` right). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md), present only when suppressed. #### Since MediaWiki 1.47 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockhidden) *** ### blockid? > `optional` **blockid?**: `number` Defined in: [core/query/users.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L17) ID of the block. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockid`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockid) *** ### blocknocreate? > `optional` **blocknocreate?**: `boolean` Defined in: [core/query/users.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L49) Whether the block prevents account creation. A real `boolean`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blocknocreate`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blocknocreate) *** ### blockowntalk? > `optional` **blockowntalk?**: `boolean` Defined in: [core/query/users.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L66) Whether editing one's own talk page is prevented. A real `boolean`. #### Since MediaWiki 1.41 #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockowntalk`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockowntalk) *** ### blockpartial? > `optional` **blockpartial?**: `boolean` Defined in: [core/query/users.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L46) Whether the block only applies to certain pages, namespaces and/or actions. A real `boolean`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockpartial`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockpartial) *** ### blockreason? > `optional` **blockreason?**: `string` Defined in: [core/query/users.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L26) Block reason, in plain text. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`blockreason`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#blockreason) *** ### cancreateaccount? > `optional` **cancreateaccount?**: `boolean` Defined in: [core/query/userinfo.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L79) Whether the user can create accounts. `uiprop=cancreateaccount`; a real `boolean` (`false` when a policy prevents it), not a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.40 *** ### cancreateaccounterror? > `optional` **cancreateaccounterror?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/query/userinfo.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L91) Why account creation is not allowed, as message objects. `uiprop=cancreateaccount`; present only when the `cancreateaccount` check does not pass. The shape follows the request's `errorformat`: under the default (`bc`) format these are `{ message, params, code, type }` specs, under a modern format they are full [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)s. #### Since MediaWiki 1.40 *** ### centralids? > `optional` **centralids?**: `Record`\<`string`, `number`> Defined in: [core/query/users.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L128) Global (CentralAuth) ids keyed by provider. `usprop=centralids` / `uiprop=centralids`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`centralids`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#centralids) *** ### changeablegroups? > `optional` **changeablegroups?**: `object` Defined in: [core/query/userinfo.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L59) Groups the (current) user may add/remove, and the self-service subsets. `uiprop=changeablegroups`. Hyphenated keys are literal. #### add? > `optional` **add?**: `string`\[] Groups the user may grant to others. #### add-self? > `optional` **add-self?**: `string`\[] Groups the user may grant to their own account. #### remove? > `optional` **remove?**: `string`\[] Groups the user may revoke from others. #### remove-self? > `optional` **remove-self?**: `string`\[] Groups the user may revoke from their own account. *** ### editcount? > `optional` **editcount?**: `number` Defined in: [core/query/users.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L113) Total edit count. `usprop=editcount` / `uiprop=editcount`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`editcount`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#editcount) *** ### email? > `optional` **email?**: `string` Defined in: [core/query/userinfo.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L140) The user's email address. `uiprop=email`, and only for a caller with `viewmyprivateinfo`. An **empty string** when the address is unset or hidden, otherwise the address. *** ### emailauthenticated? > `optional` **emailauthenticated?**: `string` Defined in: [core/query/userinfo.ts:143](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L143) When the email address was confirmed. `uiprop=email`; absent when never confirmed. *** ### groupmemberships? > `optional` **groupmemberships?**: [`ApiUserGroupMembership`](https://types-mediawiki-response.pages.dev/api/core/ApiUserGroupMembership.md)\[] Defined in: [core/query/users.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L119) Group memberships with grant/expiry metadata. `usprop=groupmemberships` / `uiprop=groupmemberships`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`groupmemberships`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#groupmemberships) *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [core/query/users.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L116) Groups the user belongs to (including implicit). `usprop=groups` / `uiprop=groups`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`groups`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#groups) *** ### id > **id**: `number` Defined in: [core/query/userinfo.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L37) User id; `0` for anonymous users. *** ### implicitgroups? > `optional` **implicitgroups?**: `string`\[] Defined in: [core/query/users.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L122) Groups that apply by virtue of an inherent right, not membership. `usprop=implicitgroups` / `uiprop=implicitgroups`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`implicitgroups`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#implicitgroups) *** ### latestcontrib? > `optional` **latestcontrib?**: `string` Defined in: [core/query/userinfo.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L100) Timestamp of the user's latest edit. `uiprop=latestcontrib`; absent with no edits. *** ### messages? > `optional` **messages?**: `boolean` Defined in: [core/query/userinfo.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L53) Whether the user has unread talk-page messages. `uiprop=hasmsg`; a real `boolean`. *** ### name > **name**: `string` Defined in: [core/query/userinfo.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L40) User name or IP address. *** ### options? > `optional` **options?**: `Record`\<`string`, `string` | `number` | `boolean` | `null`> Defined in: [core/query/userinfo.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L94) The user's preferences map (open; site/user specific). `uiprop=options`. *** ### ratelimits? > `optional` **ratelimits?**: `Record`\<`string`, `Record`\<`string`, [`ApiRateLimit`](https://types-mediawiki-response.pages.dev/api/core/ApiRateLimit.md)>> Defined in: [core/query/userinfo.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L103) Effective rate limits keyed by action then bucket. `uiprop=ratelimits`. *** ### realname? > `optional` **realname?**: `string` Defined in: [core/query/userinfo.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L133) Real name. `uiprop=realname`; also absent when `$wgHiddenPrefs` includes `realname`. *** ### registrationdate? > `optional` **registrationdate?**: `string` Defined in: [core/query/userinfo.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L97) Registration timestamp. `uiprop=registrationdate`. *** ### rights? > `optional` **rights?**: `string`\[] Defined in: [core/query/users.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L125) Effective rights. `usprop=rights` / `uiprop=rights`. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`rights`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#rights) *** ### systemblocktype? > `optional` **systemblocktype?**: `string` Defined in: [core/query/users.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L69) Type of the automatically applied system block; only for system blocks. #### Inherited from [`ApiUserCore`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md).[`systemblocktype`](https://types-mediawiki-response.pages.dev/api/core/ApiUserCore.md#systemblocktype) *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/userinfo.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L50) `true` for a temporary (auto-created) account. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 *** ### theoreticalratelimits? > `optional` **theoreticalratelimits?**: `Record`\<`string`, `Record`\<`string`, [`ApiRateLimit`](https://types-mediawiki-response.pages.dev/api/core/ApiRateLimit.md)>> Defined in: [core/query/userinfo.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L110) Rate limits that _would_ apply to this user, ignoring the exemptions they actually hold (e.g. `noratelimit`). Same shape as [ratelimits](#ratelimits); `uiprop=theoreticalratelimits`. *** ### unreadcount? > `optional` **unreadcount?**: `string` | `number` Defined in: [core/query/userinfo.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L127) Number of unread watchlist notifications; the string `1000+` once the count reaches the cap. `uiprop=unreadcount`. *** ### watchlistlabels? > `optional` **watchlistlabels?**: [`ApiWatchlistLabel`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md)\[] Defined in: [core/query/userinfo.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/userinfo.ts#L121) Custom watchlist exclusion/inclusion labels. `uiprop=watchlistlabels`; requires `$wgEnableWatchlistLabels`, and `[]` when none are set. #### Since MediaWiki 1.46 --- url: https://types-mediawiki-response.pages.dev/api/core/ApiUserrightsResponse.md --- > 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: ApiUserrightsResponse Defined in: [core/userrights.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/userrights.ts#L16) Response of `action=userrights`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### userrights > **userrights**: `object` Defined in: [core/userrights.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/userrights.ts#L18) Result of `action=userrights`. #### added > **added**: `string`\[] Groups added by this call. #### removed > **removed**: `string`\[] Groups removed by this call. #### user > **user**: `string` Canonical user name. #### userid > **userid**: `number` User id. #### watchlistexpiry? > `optional` **watchlistexpiry?**: [`WatchlistExpiry`](https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md) Expiry of the watch on the user's user page, present only when `watchuser=1` took effect. #### watchuser? > `optional` **watchuser?**: `boolean` Echoes the `watchuser` request parameter (`false` when the target is not a local user). Watching applies to the user's **user page**. ##### Since MediaWiki 1.41 *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiValidatePasswordResponse.md --- > 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: ApiValidatePasswordResponse Defined in: [core/validatepassword.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/validatepassword.ts#L23) Response of `action=validatepassword`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### validatepassword > **validatepassword**: `object` Defined in: [core/validatepassword.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/validatepassword.ts#L25) Result of `action=validatepassword`. #### validity > **validity**: [`ApiPasswordValidity`](https://types-mediawiki-response.pages.dev/api/core/ApiPasswordValidity.md) Password-policy verdict for the submitted password. #### validitymessages? > `optional` **validitymessages?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Policy messages explaining a non-`Good` verdict, shaped per the request's `errorformat`. *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWarningDetail.md --- > 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: ApiWarningDetail Defined in: [envelope/index.ts:159](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L159) One `bc`-format warning entry (the value of a module key in `warnings`). ## Properties ### warnings > **warnings**: `string` Defined in: [envelope/index.ts:161](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L161) Warning text (`bc` errorformat). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md --- > 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. # Type Alias: ApiWarnings > **ApiWarnings** = `Record`\<`string`, [`ApiWarningDetail`](https://types-mediawiki-response.pages.dev/api/core/ApiWarningDetail.md)> | [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] Defined in: [envelope/index.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L168) Warnings shape, polymorphic on `errorformat`: `bc` → object keyed by module name; modern → array of [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md). --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWatchEntry.md --- > 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: ApiWatchEntry Defined in: [core/watch.ts:13](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L13) One watched/unwatched page. ## Properties ### errors? > `optional` **errors?**: ([`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) | [`ApiError`](https://types-mediawiki-response.pages.dev/api/core/ApiError.md) | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md))\[] Defined in: [core/watch.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L45) In-band messages when the watch/unwatch operation failed (pageset mode; the legacy `title` mode dies with a top-level error instead). Heterogeneous: messages raised by the operation itself follow the request's `errorformat` ([ApiSpecMessage](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md) under `bc`, [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one), while a watchlist-label failure carries the legacy `{ code, info }` shape under `bc`, and an [ApiMessage](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md) under a modern one. *** ### expiry? > `optional` **expiry?**: `string` Defined in: [core/watch.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L35) Expiry applied to the watch (the `expiry` parameter echoed back). Watch direction only. *** ### labels? > `optional` **labels?**: [`ApiWatchlistLabel`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md)\[] Defined in: [core/watch.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L56) Watchlist labels just saved for this page, echoed back when the request passed `labels` and `$wgEnableWatchlistLabels` is on. #### Since MediaWiki 1.46 *** ### ns > **ns**: `number` Defined in: [core/watch.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L18) Namespace index. *** ### title > **title**: `string` Defined in: [core/watch.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L15) Page title. *** ### unwatched? > `optional` **unwatched?**: `boolean` Defined in: [core/watch.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L24) The page was removed from the watchlist. A real `boolean`. *** ### warnings? > `optional` **warnings?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[] Defined in: [core/watch.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L48) In-band warnings for a failed operation (present when non-empty), shaped per the request's `errorformat`. *** ### watchable? > `optional` **watchable?**: `0` Defined in: [core/watch.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L29) The page is not watchable — always `0`; `watched`/`unwatched` are absent. *** ### watched? > `optional` **watched?**: `boolean` Defined in: [core/watch.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L21) The page was added to the watchlist. A real `boolean`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWatchResponse.md --- > 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: ApiWatchResponse Defined in: [core/watch.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L60) Response of `action=watch`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) *** ### watch > **watch**: [`ApiWatchEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchEntry.md) | [`ApiWatchEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchEntry.md)\[] Defined in: [core/watch.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/watch.ts#L62) Result of `action=watch`: one object for the legacy `title=` parameter, a list for the page-set parameters. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistEntry.md --- > 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: ApiWatchlistEntry Defined in: [core/query/watchlist.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L19) One watchlist entry. `wlprop` controls which fields appear. ## Extends - [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md) ## Properties ### actionhidden? > `optional` **actionhidden?**: `true` Defined in: [core/query/watchlist.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L121) The log action is hidden (log-deleted). `wlprop=ids|title|loginfo` (only for `type=log`); a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### anon? > `optional` **anon?**: `boolean` Defined in: [core/query/watchlist.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L76) Made by an anonymous editor. `wlprop=user|userid`; a real `boolean`. *** ### autopatrolled? > `optional` **autopatrolled?**: `boolean` Defined in: [core/query/watchlist.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L112) Auto-patrolled flag. `wlprop=patrol`; a real `boolean`. *** ### bot? > `optional` **bot?**: `boolean` Defined in: [core/query/watchlist.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L79) Made by a bot. `wlprop=flags`; a real `boolean`. *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/watchlist.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L100) Raw summary. `wlprop=comment`. *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/watchlist.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L127) The edit summary is hidden (revision-deleted). `wlprop=comment|parsedcomment`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Overrides [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#commenthidden) *** ### expiry? > `optional` **expiry?**: `string` | `false` Defined in: [core/query/watchlist.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L118) Upcoming protection expiry, or `false` when none. `wlprop=expiry`. *** ### labels? > `optional` **labels?**: [`ApiWatchlistLabel`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md)\[] Defined in: [core/query/watchlist.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L135) Watchlist labels attached to the page. `wlprop=labels`; requires `$wgEnableWatchlistLabels`, and `[]` when there are none. #### Since MediaWiki 1.46 *** ### logaction? > `optional` **logaction?**: `string` Defined in: [core/query/watchlist.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L45) Log action. `wlprop=loginfo` (only for `type=log`). *** ### logdisplay? > `optional` **logdisplay?**: `string` Defined in: [core/query/watchlist.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L57) Localized log action text, e.g. `changed protection settings`. `wlprop=loginfo` (only for `type=log`). *** ### logid? > `optional` **logid?**: `number` Defined in: [core/query/watchlist.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L39) Log id. `wlprop=loginfo` (only for `type=log`). *** ### logparams? > `optional` **logparams?**: [`ApiLogEventParams`](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md) Defined in: [core/query/watchlist.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L51) Structured log details — see [ApiLogEventParams](https://types-mediawiki-response.pages.dev/api/core/ApiLogEventParams.md). `wlprop=loginfo` (only for `type=log`). *** ### logtype? > `optional` **logtype?**: `string` Defined in: [core/query/watchlist.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L42) Log type. `wlprop=loginfo` (only for `type=log`). *** ### minor? > `optional` **minor?**: `boolean` Defined in: [core/query/watchlist.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L85) Was a minor edit. `wlprop=flags`; a real `boolean`. *** ### new? > `optional` **new?**: `boolean` Defined in: [core/query/watchlist.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L82) Created a new page. `wlprop=flags`; a real `boolean`. *** ### newlen? > `optional` **newlen?**: `number` Defined in: [core/query/watchlist.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L91) New revision size in bytes. `wlprop=sizes`. *** ### notificationtimestamp? > `optional` **notificationtimestamp?**: `string` Defined in: [core/query/watchlist.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L97) When the user last saw the page; `""` when never. `wlprop=notificationtimestamp`. *** ### ns? > `optional` **ns?**: `number` Defined in: [core/query/watchlist.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L24) Namespace index. *** ### old_revid? > `optional` **old_revid?**: `number` Defined in: [core/query/watchlist.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L36) Previous revision id. `wlprop=ids`. *** ### oldlen? > `optional` **oldlen?**: `number` Defined in: [core/query/watchlist.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L88) Old revision size in bytes. `wlprop=sizes`. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [core/query/watchlist.ts:30](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L30) Page id. `wlprop=ids`. *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/watchlist.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L103) HTML-rendered summary. `wlprop=parsedcomment`. *** ### patrolled? > `optional` **patrolled?**: `boolean` Defined in: [core/query/watchlist.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L106) Whether the change is patrolled. `wlprop=patrol`; a real `boolean`. *** ### revid? > `optional` **revid?**: `number` Defined in: [core/query/watchlist.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L33) Revision id. `wlprop=ids`. *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#suppressed) *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [core/query/watchlist.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L115) Change tags. `wlprop=tags`. *** ### temp? > `optional` **temp?**: `boolean` Defined in: [core/query/watchlist.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L73) Made by a temporary account. `wlprop=user`; a real `boolean`. #### Since MediaWiki 1.42 *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/watchlist.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L94) Change timestamp. `wlprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [core/query/watchlist.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L27) Page title. *** ### type? > `optional` **type?**: [`RecentChangeType`](https://types-mediawiki-response.pages.dev/api/core/RecentChangeType.md) Defined in: [core/query/watchlist.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L21) Change type. *** ### unpatrolled? > `optional` **unpatrolled?**: `boolean` Defined in: [core/query/watchlist.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L109) Unpatrolled flag. `wlprop=patrol`; a real `boolean`. *** ### user? > `optional` **user?**: `string` | `number` Defined in: [core/query/watchlist.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L63) Actor user name or IP. `wlprop=user`; under `wlprop=userid` only, the actor's user id (number) for backwards compatibility. *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/watchlist.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L124) The author is hidden. `wlprop=user|userid`; a [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Overrides [`ApiHiddenFlags`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiHiddenFlags.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/watchlist.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlist.ts#L66) Actor user id. `wlprop=userid`. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistLabel.md --- > 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: ApiWatchlistLabel Defined in: [common/index.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L77) A watchlist label (`{ id, name }`), as returned by `meta=userinfo` `uiprop=watchlistlabels`, `prop=info` `inprop=watchlistlabels`, `list=watchlist` `wlprop=labels`, and echoed by `action=watch`. Requires `$wgEnableWatchlistLabels`. Emitted as a list; an empty set serializes as `[]`. ## Since MediaWiki 1.46 ## Properties ### id? > `optional` **id?**: `number` Defined in: [common/index.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L79) Stable numeric label id. *** ### name? > `optional` **name?**: `string` Defined in: [common/index.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L82) Label text. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawEntry.md --- > 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: ApiWatchlistRawEntry Defined in: [core/query/watchlistraw.ts:18](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L18) One watched title. ## Properties ### changed? > `optional` **changed?**: `string` Defined in: [core/query/watchlistraw.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L29) When the entry was last visited, i.e. the "changed since" marker. `wrprop=changed`; absent for entries never viewed. *** ### ns > **ns**: `number` Defined in: [core/query/watchlistraw.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L20) Namespace index. *** ### title > **title**: `string` Defined in: [core/query/watchlistraw.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L23) Full page title. --- url: https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawResponse.md --- > 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: ApiWatchlistRawResponse Defined in: [core/query/watchlistraw.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L43) Response of a query whose only module is `list=watchlistraw`: because the module writes outside `query`, the envelope comes back without a `query` member. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### continue? > `optional` **continue?**: [`ApiQueryContinue`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryContinue.md) Defined in: [core/query/watchlistraw.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L45) Cursors to pass back on the next request to fetch the following titles. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) *** ### watchlistraw? > `optional` **watchlistraw?**: [`ApiWatchlistRawEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiWatchlistRawEntry.md)\[] Defined in: [core/query/watchlistraw.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/watchlistraw.ts#L48) Raw watchlist titles (`list=watchlistraw`). --- url: https://types-mediawiki-response.pages.dev/api/core/BlockExpiry.md --- > 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. # Type Alias: BlockExpiry > **BlockExpiry** = [`Timestamp`](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) | `"infinite"` Defined in: [common/index.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L29) Expiry of a block as an action result reports it: a timestamp, or the literal `infinite` for an indefinite block. --- url: https://types-mediawiki-response.pages.dev/api/core/CaseSensitivity.md --- > 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. # Type Alias: CaseSensitivity > **CaseSensitivity** = `"first-letter"` | `"case-sensitive"` | `string` & `object` Defined in: [core/query/siteinfo.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/siteinfo.ts#L21) Whether/case-sensitivity of page titles in a namespace. Open union for forward compatibility. --- url: https://types-mediawiki-response.pages.dev/api/core/CategoryMemberType.md --- > 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. # Type Alias: CategoryMemberType > **CategoryMemberType** = `"page"` | `"subcat"` | `"file"` Defined in: [core/query/categorymembers.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/categorymembers.ts#L14) Member type (`cmtype` / `gcmtype`). --- url: https://types-mediawiki-response.pages.dev/api/core/ContentFormat.md --- > 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. # Type Alias: ContentFormat > **ContentFormat** = `"text/x-wiki"` | `"text/plain"` | `"text/javascript"` | `"text/css"` | `"application/json"` | `string` & `object` Defined in: [common/index.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L127) Serialization format of a revision slot, e.g. `text/x-wiki`. **Open union**: known core formats are listed for autocomplete and `(string & {})` keeps the type forward-compatible with extension-provided formats. --- url: https://types-mediawiki-response.pages.dev/api/core/ContentModel.md --- > 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. # Type Alias: ContentModel > **ContentModel** = `"wikitext"` | `"javascript"` | `"css"` | `"json"` | `"text"` | `"Scribunto"` | `ContentModelExtension`\[keyof `ContentModelExtension`] | `string` & `object` Defined in: [common/index.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L96) Content model of a page. **Open union** — known values are autocomplete sugar only; `(string & {})` accepts any model a response may carry. Coverage policy: MediaWiki core models are listed directly; `Scribunto` is included as the one near-universal extension model; extension packs promote their own models by augmenting [ContentModelExtension](https://types-mediawiki-response.pages.dev/api/core/ContentModelExtension.md) (e.g. `MassMessageListContent` from the MassMessage pack); consumers may augment the same interface for site-specific models registered through `$wgContentHandlers`. --- url: https://types-mediawiki-response.pages.dev/api/core/ContentModelExtension.md --- > 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: ContentModelExtension Defined in: [common/index.ts:120](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L120) Augmentation target for content models beyond MediaWiki core: extension packs and consumers merge members here (each mapping the model name to itself) to promote them to first-class known values of [ContentModel](https://types-mediawiki-response.pages.dev/api/core/ContentModel.md). ## Example ```ts // A site-specific model registered through $wgContentHandlers: declare module "types-mediawiki-response" { interface ContentModelExtension { MyModel: "my-model"; } } ``` --- url: https://types-mediawiki-response.pages.dev/api/core/ContributorsPage.md --- > 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. # Type Alias: ContributorsPage > **ContributorsPage** = [`QueryPage`](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md)\ Defined in: [core/query/contributors.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/contributors.ts#L40) A page projected to everything `prop=contributors` contributes, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). --- url: https://types-mediawiki-response.pages.dev/api/core/Expiry.md --- > 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. # Type Alias: Expiry > **Expiry** = [`Timestamp`](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) | `"infinity"` Defined in: [common/index.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L23) Expiry of a temporary state: a timestamp, or the literal `infinity` when it does not expire. Block records spell the permanent case `infinite` instead — see [BlockExpiry](https://types-mediawiki-response.pages.dev/api/core/BlockExpiry.md). --- url: https://types-mediawiki-response.pages.dev/api/core/Flag.md --- > 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. # Type Alias: Flag > **Flag** = `true` Defined in: [common/index.ts:10](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L10) MediaWiki boolean-style flags: present as `true` when set, otherwise absent. ## See [https://www.mediawiki.org/wiki/API:JSON_version_2](https://www.mediawiki.org/wiki/API:JSON_version_2) --- url: https://types-mediawiki-response.pages.dev/api/core/ImageInfoPage.md --- > 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. # Type Alias: ImageInfoPage > **ImageInfoPage** = [`QueryPage`](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md)\ Defined in: [core/query/imageinfo.ts:277](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L277) A page projected to everything `prop=imageinfo` contributes, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). --- url: https://types-mediawiki-response.pages.dev/api/core/InfoPage.md --- > 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. # Type Alias: InfoPage > **InfoPage** = [`QueryPage`](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md)\ Defined in: [core/query/info.ts:261](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L261) A page projected to everything `prop=info` contributes, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). --- url: https://types-mediawiki-response.pages.dev/api/core/InfoPageExisting.md --- > 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. # Type Alias: InfoPageExisting > **InfoPageExisting** = [`QueryPageExisting`](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md)\ Defined in: [core/query/info.ts:268](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/info.ts#L268) [InfoPage](https://types-mediawiki-response.pages.dev/api/core/InfoPage.md) for a page that exists: the identity fields and the unconditional `prop=info` fields (`PropConstantKeys`) are required; `inprop`-gated fields stay optional. --- url: https://types-mediawiki-response.pages.dev/api/core/NamespaceIndex.md --- > 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. # Type Alias: NamespaceIndex > **NamespaceIndex** = `number` Defined in: [common/index.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L44) Namespace index. Negative indexes are pseudo-namespaces. --- url: https://types-mediawiki-response.pages.dev/api/core/PlainText.md --- > 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. # Type Alias: PlainText > **PlainText** = `string` Defined in: [common/index.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L41) A block of plain text (as opposed to HTML), e.g. a TextExtracts excerpt requested with `explaintext`. Kept distinct from HTML-bearing string fields. --- url: https://types-mediawiki-response.pages.dev/api/core/PropConstantKeys.md --- > 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. # Type Alias: PropConstantKeys > **PropConstantKeys** = `"contentmodel"` | `"pagelanguage"` | `"pagelanguagehtmlcode"` | `"pagelanguagedir"` | `"touched"` | `"lastrevid"` | `"length"` | `"revisions"` Defined in: [core/query/index.ts:452](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L452) `prop=` fields their module writes unconditionally on an existing page. On [QueryPageExisting](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md) these are required when picked; on the all-state [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) they stay optional, because invalid/special entries never carry prop fields. Every other `prop=` key is omitted when its data is absent (empty lists, non-file pages, non-category pages), so it stays optional even on [QueryPageExisting](https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md). --- url: https://types-mediawiki-response.pages.dev/api/core/ProtectedTitleLevel.md --- > 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. # Type Alias: ProtectedTitleLevel > **ProtectedTitleLevel** = `"autoconfirmed"` | `"sysop"` | `string` & `object` Defined in: [core/query/protectedtitles.ts:14](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/protectedtitles.ts#L14) Create-protection level of a protected title — an entry of `$wgRestrictionLevels` (core default: `autoconfirmed`, `sysop`). **Open union**: `sreview` comes from FlaggedRevs, so the set is site-dependent. --- url: https://types-mediawiki-response.pages.dev/api/core/QueryPage.md --- > 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. # Type Alias: QueryPage\ > **QueryPage**\<`K`> = [`ApiPageIdentity`](https://types-mediawiki-response.pages.dev/api/core/ApiPageIdentity.md) & `Pick`\<[`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md), `K` | `"index"`> Defined in: [core/query/index.ts:425](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L425) A page scoped to a chosen set of `prop=` fields: identity fields plus the named keys only. Lets callers reflect what they requested and get a compile error when reading a prop they did not ask for. The generator-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index) is included as well, because it comes from the query framework rather than from a `prop=`. ## Type Parameters ### K `K` _extends_ keyof [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) ## Example ```ts // identity + revisions only (categories/links/... are not offered) const pages = Object.values(res.query.pages) as QueryPage<'revisions'>[]; ``` --- url: https://types-mediawiki-response.pages.dev/api/core/QueryPageExisting.md --- > 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. # Type Alias: QueryPageExisting\ > **QueryPageExisting**\<`K`> = `Require`\<[`QueryPage`](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md)\<`K`>, `"pageid"` | `"ns"` | `"title"` | `Extract`\<`K`, [`PropConstantKeys`](https://types-mediawiki-response.pages.dev/api/core/PropConstantKeys.md)>> Defined in: [core/query/index.ts:472](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/index.ts#L472) [QueryPage](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md) for a page that exists: the identity fields are required rather than optional, and picked `prop=` fields that their module writes unconditionally ([PropConstantKeys](https://types-mediawiki-response.pages.dev/api/core/PropConstantKeys.md)) are required too. See [ApiPageExisting](https://types-mediawiki-response.pages.dev/api/core/ApiPageExisting.md) for when this holds. ## Type Parameters ### K `K` _extends_ keyof [`ApiPage`](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md) ## Example ```ts // identity + revisions only, with pageid/ns/title required const pages = Object.values(res.query.pages) as QueryPageExisting<'revisions'>[]; ``` --- url: https://types-mediawiki-response.pages.dev/api/core/RecentChangeType.md --- > 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. # Type Alias: RecentChangeType > **RecentChangeType** = `"edit"` | `"new"` | `"log"` | `"categorize"` | `"external"` | `string` & `object` Defined in: [core/query/recentchanges.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/recentchanges.ts#L15) Change type (`rctype`). Open union for forward compatibility. --- url: https://types-mediawiki-response.pages.dev/api/core/RevisionDeleteStatus.md --- > 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. # Type Alias: RevisionDeleteStatus > **RevisionDeleteStatus** = `"Success"` | `"Fail"` | `string` & `object` Defined in: [core/revisiondelete.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/revisiondelete.ts#L20) Per-item outcome. Open union for forward compatibility. --- url: https://types-mediawiki-response.pages.dev/api/core/SearchPage.md --- > 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. # Type Alias: SearchPage > **SearchPage** = [`QueryPage`](https://types-mediawiki-response.pages.dev/api/core/QueryPage.md)\ Defined in: [core/query/search.ts:181](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/search.ts#L181) A page projected to the hit fields `generator=search` injects, plus the framework-injected [ApiPage.index](https://types-mediawiki-response.pages.dev/api/core/ApiPage.md#index). --- url: https://types-mediawiki-response.pages.dev/api/core/Timestamp.md --- > 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. # Type Alias: Timestamp > **Timestamp** = `string` Defined in: [common/index.ts:16](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L16) A MediaWiki timestamp in ISO 8601 format (UTC), e.g. `2024-01-15T08:30:00Z`. --- url: https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md --- > 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. # Type Alias: WatchlistExpiry > **WatchlistExpiry** = [`Timestamp`](https://types-mediawiki-response.pages.dev/api/core/Timestamp.md) | `null` Defined in: [common/index.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/common/index.ts#L35) Expiry of a watch: a timestamp, or `null` when the page is not watched or the watch is permanent. --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/overview.md --- > 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. # AbuseFilter ## Interfaces | Interface | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | [ApiAbuseFilter](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilter.md) | One abuse filter definition. | | [ApiAbuseFilterCheckMatchResponse](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckMatchResponse.md) | Response of `action=abusefiltercheckmatch`. | | [ApiAbuseFilterCheckSyntaxResponse](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckSyntaxResponse.md) | Response of `action=abusefilterchecksyntax`. | | [ApiAbuseFilterEvalExpressionResponse](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterEvalExpressionResponse.md) | Response of `action=abusefilterevalexpression`. | | [ApiAbuseFilterUnblockAutopromoteResponse](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterUnblockAutopromoteResponse.md) | Response of `action=abusefilterunblockautopromote`. | | [ApiAbuseLogEntry](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogEntry.md) | One abuse-log entry (`list=abuselog`). | | [ApiAbuseLogPrivateDetailsResponse](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogPrivateDetailsResponse.md) | Response of `action=abuselogprivatedetails` (needs `abusefilter-privatedetails`). | ## Type Aliases | Type Alias | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | [AbuseFilterSyntaxStatus](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/AbuseFilterSyntaxStatus.md) | Status of a syntax check (`action=abusefilterchecksyntax`). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/AbuseFilterSyntaxStatus.md --- > 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. # Type Alias: AbuseFilterSyntaxStatus > **AbuseFilterSyntaxStatus** = `"ok"` | `"error"` | `string` & `object` Defined in: [extensions/abusefilters.ts:172](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L172) Status of a syntax check (`action=abusefilterchecksyntax`). --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilter.md --- > 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: ApiAbuseFilter Defined in: [extensions/abusefilters.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L33) One abuse filter definition. ## Properties ### actions? > `optional` **actions?**: `string` | `string`\[] Defined in: [extensions/abusefilters.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L49) The actions the filter performs. `abfprop=actions`. - Up to MediaWiki 1.46: the raw `af_actions` column, a comma-joined string such as `"disallow,tag"`. - 1.47 onward: the same value split into a `string[]`. *** ### comments? > `optional` **comments?**: `string` Defined in: [extensions/abusefilters.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L52) The filter's comments. `abfprop=comments` (withheld for private/protected filters). *** ### commentsredacted? > `optional` **commentsredacted?**: `true` Defined in: [extensions/abusefilters.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L79) `true` when `comments` was withheld from this viewer. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Before 1.47, a withheld [comments](#comments) was simply omitted. #### Since MediaWiki 1.47 *** ### deleted? > `optional` **deleted?**: `boolean` | `""` Defined in: [extensions/abusefilters.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L95) Whether the filter is soft-deleted. `abfprop=status`; same `""` (1.43) vs real boolean (newer `abfprop=flags`) behaviour as [enabled](#enabled). *** ### description? > `optional` **description?**: `string` Defined in: [extensions/abusefilters.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L38) Human-readable filter description. `abfprop=description`. *** ### enabled? > `optional` **enabled?**: `boolean` | `""` Defined in: [extensions/abusefilters.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L92) Whether the filter is enabled. `abfprop=status`. - 1.43: present as an **empty string** when the flag applies, and absent otherwise. - Newer builds (`abfprop=flags`): real booleans. *** ### hits? > `optional` **hits?**: `number` Defined in: [extensions/abusefilters.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L55) Number of matches (only when the viewer may see it). `abfprop=hits`. *** ### hitsredacted? > `optional` **hitsredacted?**: `true` Defined in: [extensions/abusefilters.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L63) `true` when `hits` was withheld from this viewer. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Before 1.47, a withheld [hits](#hits) was simply omitted. #### Since MediaWiki 1.47 *** ### id? > `optional` **id?**: `number` Defined in: [extensions/abusefilters.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L35) Filter id. *** ### lasteditor? > `optional` **lasteditor?**: `string` Defined in: [extensions/abusefilters.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L82) Last editor of the filter. `abfprop=lasteditor`. *** ### lastedittime? > `optional` **lastedittime?**: `string` Defined in: [extensions/abusefilters.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L85) Last edit timestamp. `abfprop=lastedittime`. *** ### pattern? > `optional` **pattern?**: `string` Defined in: [extensions/abusefilters.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L41) The filter's regex/rule string. `abfprop=pattern` (withheld for private/protected filters). *** ### patternredacted? > `optional` **patternredacted?**: `true` Defined in: [extensions/abusefilters.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L71) `true` when `pattern` was withheld from this viewer. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). Before 1.47, a withheld [pattern](#pattern) was simply omitted. #### Since MediaWiki 1.47 *** ### private? > `optional` **private?**: `boolean` | `""` Defined in: [extensions/abusefilters.ts:98](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L98) Whether the filter is private (hidden from the viewer). `abfprop=private`; same `""` (1.43) vs real boolean (newer `abfprop=flags`) behaviour as [enabled](#enabled). *** ### protected? > `optional` **protected?**: `boolean` | `""` Defined in: [extensions/abusefilters.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L106) Whether the filter's protected variables are hidden. Same `""` (1.43) vs real boolean (newer `abfprop=flags`) behaviour as [enabled](#enabled). #### Since MediaWiki 1.43 *** ### suppressed? > `optional` **suppressed?**: `boolean` Defined in: [extensions/abusefilters.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L115) Whether the filter is suppressed (oversight). A real `boolean` under `abfprop=flags`; the per-flag `abfprop=suppressed` alias is itself deprecated since 1.47. #### Since MediaWiki 1.47 --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckMatchResponse.md --- > 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: ApiAbuseFilterCheckMatchResponse Defined in: [extensions/abusefilters.ts:214](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L214) Response of `action=abusefiltercheckmatch`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### abusefiltercheckmatch > **abusefiltercheckmatch**: `object` Defined in: [extensions/abusefilters.ts:216](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L216) Result of `action=abusefiltercheckmatch`. #### result? > `optional` **result?**: `boolean` Whether the pattern matches the supplied variables. A real `boolean`. *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterCheckSyntaxResponse.md --- > 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: ApiAbuseFilterCheckSyntaxResponse Defined in: [extensions/abusefilters.ts:175](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L175) Response of `action=abusefilterchecksyntax`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### abusefilterchecksyntax > **abusefilterchecksyntax**: `object` Defined in: [extensions/abusefilters.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L177) Result of `action=abusefilterchecksyntax`. #### character? > `optional` **character?**: `number` Character offset of the problem within the pattern. #### message? > `optional` **message?**: `string` Localized message text describing the problem. #### status? > `optional` **status?**: [`AbuseFilterSyntaxStatus`](https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/AbuseFilterSyntaxStatus.md) Check outcome; `ok` when the pattern parses. #### warnings? > `optional` **warnings?**: `object`\[] Parser warnings (e.g. an empty-match regex); present only when there is at least one, each with its own message and character offset. *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterEvalExpressionResponse.md --- > 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: ApiAbuseFilterEvalExpressionResponse Defined in: [extensions/abusefilters.ts:202](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L202) Response of `action=abusefilterevalexpression`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### abusefilterevalexpression > **abusefilterevalexpression**: `object` Defined in: [extensions/abusefilters.ts:204](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L204) Result of `action=abusefilterevalexpression`. #### result? > `optional` **result?**: `unknown` Evaluated value. A boolean, number, string or (with `prettyprint`) a formatted representation, and a structured value for some expressions. *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseFilterUnblockAutopromoteResponse.md --- > 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: ApiAbuseFilterUnblockAutopromoteResponse Defined in: [extensions/abusefilters.ts:223](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L223) Response of `action=abusefilterunblockautopromote`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### abusefilterunblockautopromote > **abusefilterunblockautopromote**: `object` Defined in: [extensions/abusefilters.ts:225](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L225) Result of `action=abusefilterunblockautopromote`. #### user? > `optional` **user?**: `string` Canonical name of the user whose autopromote block was lifted. *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogEntry.md --- > 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: ApiAbuseLogEntry Defined in: [extensions/abusefilters.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L119) One abuse-log entry (`list=abuselog`). ## Properties ### action? > `optional` **action?**: `string` Defined in: [extensions/abusefilters.ts:143](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L143) Action that was filtered, e.g. `edit`, `create`. `aflprop=action`. *** ### details? > `optional` **details?**: `unknown`\[] | `Record`\<`string`, `unknown`> Defined in: [extensions/abusefilters.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L165) Filter variables in effect. `aflprop=details`; a map keyed by variable name. Values are strings, numbers or booleans, but may also be arrays or `null`; withheld variables arrive as empty strings. An empty map arrives as `[]`. *** ### filter? > `optional` **filter?**: `string` Defined in: [extensions/abusefilters.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L131) Public description of the filter. `aflprop=filter`. *** ### filter_id? > `optional` **filter_id?**: `string` Defined in: [extensions/abusefilters.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L128) Filter that matched: the filter id as a string, prefixed `global-` for central filters (e.g. `global-42`). `aflprop=ids`; an **empty string** when the viewer may not see the details. *** ### hidden? > `optional` **hidden?**: `boolean` Defined in: [extensions/abusefilters.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L158) Whether the entry is revdel'd. `aflprop=hidden`; a real `boolean`. *** ### id? > `optional` **id?**: `number` Defined in: [extensions/abusefilters.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L121) Log record id (`afl_id`). `aflprop=ids`. *** ### ns? > `optional` **ns?**: `number` Defined in: [extensions/abusefilters.ts:137](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L137) Namespace of the affected page. `aflprop=title`. *** ### result? > `optional` **result?**: `string` Defined in: [extensions/abusefilters.ts:149](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L149) Consequences applied, e.g. `disallow`. `aflprop=result`; a comma-joined string on 1.43, as stored in `afl_actions`. *** ### revid? > `optional` **revid?**: `number` | `""` Defined in: [extensions/abusefilters.ts:152](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L152) Revision the log entry points at. `aflprop=revid`; `""` when withheld. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/abusefilters.ts:155](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L155) When the entry was recorded. `aflprop=timestamp`. *** ### title? > `optional` **title?**: `string` Defined in: [extensions/abusefilters.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L140) Title of the affected page. `aflprop=title`. *** ### user? > `optional` **user?**: `string` Defined in: [extensions/abusefilters.ts:134](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L134) Actor name. `aflprop=user`. *** ### wiki? > `optional` **wiki?**: `string` Defined in: [extensions/abusefilters.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L168) Source wiki id. `aflprop=wiki`, and only on a central filter wiki. --- url: https://types-mediawiki-response.pages.dev/api/extensions/abusefilters/ApiAbuseLogPrivateDetailsResponse.md --- > 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: ApiAbuseLogPrivateDetailsResponse Defined in: [extensions/abusefilters.ts:232](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L232) Response of `action=abuselogprivatedetails` (needs `abusefilter-privatedetails`). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### abuselogprivatedetails > **abuselogprivatedetails**: `object` Defined in: [extensions/abusefilters.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/abusefilters.ts#L234) Result of `action=abuselogprivatedetails`. #### filter-description? > `optional` **filter-description?**: `string` Public filter description. #### filter-id? > `optional` **filter-id?**: `number` Filter that matched. #### ip-address? > `optional` **ip-address?**: `string` | `null` Real IP behind the entry; `null` when the log stored none. #### log-id? > `optional` **log-id?**: `number` Log record the details belong to. #### user? > `optional` **user?**: `string` Actor of that log entry. *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/babel/overview.md --- > 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. # Babel ## Type Aliases | Type Alias | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiBabelResult](https://types-mediawiki-response.pages.dev/api/extensions/babel/ApiBabelResult.md) | A `meta=babel` result: language code → Babel level string (e.g. `"N"`, `"1"`… `"5"`). Site-configured, so the key set is open. An unknown user is an `ApiErrorResponse`, not this type. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/babel/ApiBabelResult.md --- > 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. # Type Alias: ApiBabelResult > **ApiBabelResult** = `Record`\<`string`, `string`> Defined in: [extensions/babel.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/babel.ts#L28) A `meta=babel` result: language code → Babel level string (e.g. `"N"`, `"1"`… `"5"`). Site-configured, so the key set is open. An unknown user is an `ApiErrorResponse`, not this type. --- url: https://types-mediawiki-response.pages.dev/api/extensions/betafeatures/overview.md --- > 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. # BetaFeatures ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | [ApiBetaFeature](https://types-mediawiki-response.pages.dev/api/extensions/betafeatures/ApiBetaFeature.md) | One `list=betafeatures` entry: a feature id with its user count. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/betafeatures/ApiBetaFeature.md --- > 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: ApiBetaFeature Defined in: [extensions/betafeatures.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/betafeatures.ts#L24) One `list=betafeatures` entry: a feature id with its user count. ## Properties ### count > **count**: `number` Defined in: [extensions/betafeatures.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/betafeatures.ts#L32) Number of users who enabled the feature; `0` unless `bfcounts` was requested. *** ### name > **name**: `string` Defined in: [extensions/betafeatures.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/betafeatures.ts#L26) The feature id, e.g. `mw-vector-2022-default-title`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/categorytree/overview.md --- > 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. # CategoryTree ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | | [ApiCategoryTreeResponse](https://types-mediawiki-response.pages.dev/api/extensions/categorytree/ApiCategoryTreeResponse.md) | Response of `action=categorytree`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/categorytree/ApiCategoryTreeResponse.md --- > 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: ApiCategoryTreeResponse Defined in: [extensions/categorytree.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/categorytree.ts#L22) Response of `action=categorytree`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### categorytree > **categorytree**: `object` Defined in: [extensions/categorytree.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/categorytree.ts#L27) The module's only output is a content value: `html` holds the rendered tree. The requested category is **not** echoed back. #### html? > `optional` **html?**: `string` Rendered tree markup; `""` for an empty or non-existent category. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/overview.md --- > 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. # CentralAuth ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiCentralAuthInBandErrorResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthInBandErrorResponse.md) | In-band failure of `action=deleteglobalaccount` / `action=createlocalaccount`: the messages appear under the root `error` key as a list of per-status lists — not as a standard ApiErrorResponse — so `error` carries no `code`/`info` of its own. | | [ApiCentralAuthTokenResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthTokenResponse.md) | Response of `action=centralauthtoken`: a token that authenticates the current CentralAuth session on another wiki of the farm (sent as the `centralauthtoken` parameter there). Requires a logged-in user attached to a global account whose session comes from the CentralAuth session provider; every other case is a standard top-level error (`notloggedin`, `badsession`, `notattached`). | | [ApiCreateLocalAccountResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResponse.md) | Response of `action=createlocalaccount`. Unlike `setglobalaccountstatus`, a failure returns only the root `error` list and no result object. | | [ApiCreateLocalAccountResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResult.md) | Result of `action=createlocalaccount` (CSRF-token POST, `centralauth-createlocal` right): a local account was force-created on this wiki for the global account. | | [ApiDeleteGlobalAccountResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResponse.md) | Response of `action=deleteglobalaccount`. | | [ApiDeleteGlobalAccountResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResult.md) | Result of `action=deleteglobalaccount` (its own token type POST): the global account was unmerged (deleted). | | [ApiGlobalCentralUser](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md) | One `list=globalallusers` entry. `aguprop` controls which fields beyond [ApiGlobalCentralUser.id](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md#id) / [ApiGlobalCentralUser.name](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md#name) appear. Hidden accounts (suppressed from public lists) never appear here at all. | | [ApiGlobalGroup](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroup.md) | One `list=globalgroups` entry: a global group defined on the wiki farm. The rows derive from the `global_group_permissions` table, so groups are only listed once they have at least one permission granted. | | [ApiGlobalGroupMembership](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroupMembership.md) | One global group membership of a `list=globalusers` row. | | [ApiGlobalUserFound](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md) | One `list=globalusers` entry for an existing global account. `gusprop` controls which fields beyond [ApiGlobalUserFound.centralid](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md#centralid) / [ApiGlobalUserFound.name](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md#name) appear. Results come back in request order; unknown names/ids get marker rows (see [ApiGlobalUserRow](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md)). | | [ApiGlobalUserInvalidName](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserInvalidName.md) | A `list=globalusers` row for a requested name that is not a valid username. | | [ApiGlobalUserLocalInfo](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserLocalInfo.md) | The `localinfo` object of a `list=globalusers` row. | | [ApiGlobalUserMissingId](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingId.md) | A `list=globalusers` row for a requested global id with no global account. | | [ApiGlobalUserMissingName](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingName.md) | A `list=globalusers` row for a requested name with no global account. | | [ApiGlobalUserRightsResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResponse.md) | Response of `action=globaluserrights`. Failures are standard top-level errors. | | [ApiGlobalUserRightsResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResult.md) | Result of `action=globaluserrights` (userrights-token POST): global group memberships changed for one global account. Mirrors the core `action=userrights` result shape. | | [ApiSetGlobalAccountStatusFailedResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md) | In-band failure of `action=setglobalaccountstatus`: the unchanged state object is returned without `reason`, alongside the root `error` list as a nested [ApiSpecMessage](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md) list rather than a standard `ApiErrorResponse`. Use `ApiResponseWith` to model either outcome. | | [ApiSetGlobalAccountStatusResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResponse.md) | Successful response of `action=setglobalaccountstatus`. A failed lock/hide returns the unchanged state (without `reason`) plus an in-band root `error` — see [ApiSetGlobalAccountStatusFailedResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md). | | [ApiSetGlobalAccountStatusResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md) | Result object of `action=setglobalaccountstatus` (its own token type POST): the new lock / hide state of a global account plus the reason echoed back. | | [ApiSetGlobalAccountStatusState](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md) | The lock / hide state of a global account, written by `action=setglobalaccountstatus` on every outcome. The success response extends it with [ApiSetGlobalAccountStatusResult.reason](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md#reason); a failed call reports only this state, alongside the in-band root `error` list. | | [ApiWikiSet](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiWikiSet.md) | One `list=wikisets` entry: a named wiki set (a list of wikis used for global group restrictions). The key set is farm-configured. | ## Type Aliases | Type Alias | Description | | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiGlobalUserRow](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md) | One `list=globalusers` row: either a found account ([ApiGlobalUserFound](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md)) or a marker for a name/id that is unknown (`missing`), syntactically invalid (`invalid`), or hidden from the requester (`missing` again — hidden accounts are reported as absent). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthInBandErrorResponse.md --- > 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: ApiCentralAuthInBandErrorResponse Defined in: [extensions/centralauth.ts:251](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L251) In-band failure of `action=deleteglobalaccount` / `action=createlocalaccount`: the messages appear under the root `error` key as a list of per-status lists — not as a standard ApiErrorResponse — so `error` carries no `code`/`info` of its own. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### error > **error**: [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[]\[] Defined in: [extensions/centralauth.ts:252](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L252) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthTokenResponse.md --- > 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: ApiCentralAuthTokenResponse Defined in: [extensions/centralauth.ts:238](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L238) Response of `action=centralauthtoken`: a token that authenticates the current CentralAuth session on another wiki of the farm (sent as the `centralauthtoken` parameter there). Requires a logged-in user attached to a global account whose session comes from the CentralAuth session provider; every other case is a standard top-level error (`notloggedin`, `badsession`, `notattached`). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### centralauthtoken > **centralauthtoken**: `object` Defined in: [extensions/centralauth.ts:239](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L239) #### centralauthtoken > **centralauthtoken**: `string` The cross-wiki authentication token. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResponse.md --- > 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: ApiCreateLocalAccountResponse Defined in: [extensions/centralauth.ts:225](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L225) Response of `action=createlocalaccount`. Unlike `setglobalaccountstatus`, a failure returns only the root `error` list and no result object. ## Since MediaWiki 1.36 ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### createlocalaccount > **createlocalaccount**: [`ApiCreateLocalAccountResult`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResult.md) Defined in: [extensions/centralauth.ts:227](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L227) Result of `action=createlocalaccount`. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResult.md --- > 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: ApiCreateLocalAccountResult Defined in: [extensions/centralauth.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L211) Result of `action=createlocalaccount` (CSRF-token POST, `centralauth-createlocal` right): a local account was force-created on this wiki for the global account. ## Since MediaWiki 1.36 ## Properties ### reason > **reason**: `string` | `null` Defined in: [extensions/centralauth.ts:216](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L216) The reason passed to the call; `null` when none was given. *** ### username > **username**: `string` Defined in: [extensions/centralauth.ts:213](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L213) The user name a local account was created for. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResponse.md --- > 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: ApiDeleteGlobalAccountResponse Defined in: [extensions/centralauth.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L200) Response of `action=deleteglobalaccount`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### deleteglobalaccount > **deleteglobalaccount**: [`ApiDeleteGlobalAccountResult`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResult.md) Defined in: [extensions/centralauth.ts:202](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L202) Result of `action=deleteglobalaccount`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResult.md --- > 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: ApiDeleteGlobalAccountResult Defined in: [extensions/centralauth.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L191) Result of `action=deleteglobalaccount` (its own token type POST): the global account was unmerged (deleted). ## Properties ### reason > **reason**: `string` | `null` Defined in: [extensions/centralauth.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L196) The reason passed to the call; `null` when none was given. *** ### user > **user**: `string` Defined in: [extensions/centralauth.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L193) The deleted global account name. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md --- > 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: ApiGlobalCentralUser Defined in: [extensions/centralauth.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L39) One `list=globalallusers` entry. `aguprop` controls which fields beyond [ApiGlobalCentralUser.id](#id) / [ApiGlobalCentralUser.name](#name) appear. Hidden accounts (suppressed from public lists) never appear here at all. ## Properties ### existslocally? > `optional` **existslocally?**: `""` Defined in: [extensions/centralauth.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L57) The account is attached to (has a local account on) the requesting wiki; an empty-string marker (stays `""` under fv2 rather than becoming `true`). `aguprop=existslocally`. *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [extensions/centralauth.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L50) Global groups of the account, `[]` when it is in none. `aguprop=groups`. Expired group memberships are not included. *** ### id > **id**: `number` Defined in: [extensions/centralauth.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L41) Global account id. *** ### locked? > `optional` **locked?**: `""` Defined in: [extensions/centralauth.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L63) The account is locked globally; an empty-string marker (see [ApiGlobalCentralUser.existslocally](#existslocally)). `aguprop=lockinfo`. *** ### name > **name**: `string` Defined in: [extensions/centralauth.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L44) Global account name. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroup.md --- > 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: ApiGlobalGroup Defined in: [extensions/centralauth.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L71) One `list=globalgroups` entry: a global group defined on the wiki farm. The rows derive from the `global_group_permissions` table, so groups are only listed once they have at least one permission granted. ## Properties ### name > **name**: `string` Defined in: [extensions/centralauth.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L73) Global group name, e.g. `global-sysop` (site-configured, not fixed). *** ### rights? > `optional` **rights?**: `string`\[] Defined in: [extensions/centralauth.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L76) Permissions granted to the group. `ggpprop=rights`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroupMembership.md --- > 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: ApiGlobalGroupMembership Defined in: [extensions/centralauth.ts:328](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L328) One global group membership of a `list=globalusers` row. ## Properties ### expiry > **expiry**: `string` Defined in: [extensions/centralauth.ts:333](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L333) Membership expiry, or `infinity`. *** ### group > **group**: `string` Defined in: [extensions/centralauth.ts:330](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L330) Global group name. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md --- > 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: ApiGlobalUserFound Defined in: [extensions/centralauth.ts:261](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L261) One `list=globalusers` entry for an existing global account. `gusprop` controls which fields beyond [ApiGlobalUserFound.centralid](#centralid) / [ApiGlobalUserFound.name](#name) appear. Results come back in request order; unknown names/ids get marker rows (see [ApiGlobalUserRow](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md)). ## Properties ### centralid > **centralid**: `number` Defined in: [extensions/centralauth.ts:263](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L263) Global account id. *** ### editcount? > `optional` **editcount?**: `number` Defined in: [extensions/centralauth.ts:291](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L291) Global edit count. `gusprop=editcount`. *** ### groupmemberships? > `optional` **groupmemberships?**: [`ApiGlobalGroupMembership`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroupMembership.md)\[] Defined in: [extensions/centralauth.ts:309](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L309) Global group memberships with expiry. `gusprop=groupmemberships`. *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [extensions/centralauth.ts:304](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L304) Global groups of the account (active ones only). `gusprop=groups`. *** ### hidden? > `optional` **hidden?**: `true` Defined in: [extensions/centralauth.ts:273](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L273) The account is hidden from public lists; a real `true`. Only observable to requesters with the `centralauth-suppress` right — for everyone else the row is replaced by a `missing` marker. *** ### localinfo? > `optional` **localinfo?**: [`ApiGlobalUserLocalInfo`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserLocalInfo.md) Defined in: [extensions/centralauth.ts:301](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L301) Attachment status on the requesting wiki. `gusprop=localinfo`; [ApiGlobalUserLocalInfo.localid](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserLocalInfo.md#localid) / [ApiGlobalUserLocalInfo.timestamp](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserLocalInfo.md#timestamp) are only present when attached. *** ### locked? > `optional` **locked?**: `boolean` Defined in: [extensions/centralauth.ts:282](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L282) Whether the account is locked globally. `gusprop=locked`. *** ### locklogid? > `optional` **locklogid?**: `number` Defined in: [extensions/centralauth.ts:288](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L288) Log id of the most recent lock on the account (for a follow-up `list=logevents` on the central wiki); present only when locked. *** ### name > **name**: `string` Defined in: [extensions/centralauth.ts:266](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L266) Global account name. *** ### registration? > `optional` **registration?**: `string` Defined in: [extensions/centralauth.ts:294](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L294) When the global account was created. `gusprop=registration`. *** ### rights? > `optional` **rights?**: `string`\[] Defined in: [extensions/centralauth.ts:312](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L312) Permissions derived from the account's global groups. `gusprop=rights`. *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [extensions/centralauth.ts:279](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L279) The account is fully suppressed; a real `true`. Same visibility rule as [ApiGlobalUserFound.hidden](#hidden). --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserInvalidName.md --- > 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: ApiGlobalUserInvalidName Defined in: [extensions/centralauth.ts:346](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L346) A `list=globalusers` row for a requested name that is not a valid username. ## Properties ### invalid > **invalid**: `true` Defined in: [extensions/centralauth.ts:351](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L351) Marker: not a valid username. *** ### name > **name**: `string` Defined in: [extensions/centralauth.ts:348](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L348) The requested name, echoed back as given. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserLocalInfo.md --- > 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: ApiGlobalUserLocalInfo Defined in: [extensions/centralauth.ts:316](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L316) The `localinfo` object of a `list=globalusers` row. ## Properties ### attached > **attached**: `boolean` Defined in: [extensions/centralauth.ts:318](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L318) The account has a local account on the requesting wiki. *** ### localid? > `optional` **localid?**: `number` | `null` Defined in: [extensions/centralauth.ts:321](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L321) Local user id; `null` when recorded without one. Only when attached. *** ### timestamp? > `optional` **timestamp?**: `string` | `null` Defined in: [extensions/centralauth.ts:324](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L324) When the local account was attached. Only when attached. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingId.md --- > 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: ApiGlobalUserMissingId Defined in: [extensions/centralauth.ts:355](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L355) A `list=globalusers` row for a requested global id with no global account. ## Properties ### centralid > **centralid**: `number` Defined in: [extensions/centralauth.ts:357](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L357) The requested global id, echoed back. *** ### missing > **missing**: `true` Defined in: [extensions/centralauth.ts:360](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L360) Marker: no global account with this id. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingName.md --- > 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: ApiGlobalUserMissingName Defined in: [extensions/centralauth.ts:337](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L337) A `list=globalusers` row for a requested name with no global account. ## Properties ### missing > **missing**: `true` Defined in: [extensions/centralauth.ts:342](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L342) Marker: no global account under this name. *** ### name > **name**: `string` Defined in: [extensions/centralauth.ts:339](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L339) The requested name, echoed back. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResponse.md --- > 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: ApiGlobalUserRightsResponse Defined in: [extensions/centralauth.ts:129](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L129) Response of `action=globaluserrights`. Failures are standard top-level errors. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### globaluserrights > **globaluserrights**: [`ApiGlobalUserRightsResult`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResult.md) Defined in: [extensions/centralauth.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L131) Result of `action=globaluserrights`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResult.md --- > 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: ApiGlobalUserRightsResult Defined in: [extensions/centralauth.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L114) Result of `action=globaluserrights` (userrights-token POST): global group memberships changed for one global account. Mirrors the core `action=userrights` result shape. ## Properties ### added > **added**: `string`\[] Defined in: [extensions/centralauth.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L122) Groups added by this call (empty when only removing). *** ### removed > **removed**: `string`\[] Defined in: [extensions/centralauth.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L125) Groups removed by this call (empty when only adding). *** ### user > **user**: `string` Defined in: [extensions/centralauth.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L116) The affected global account name. *** ### userid > **userid**: `number` Defined in: [extensions/centralauth.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L119) Global account id. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md --- > 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. # Type Alias: ApiGlobalUserRow > **ApiGlobalUserRow** = [`ApiGlobalUserFound`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md) | [`ApiGlobalUserMissingName`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingName.md) | [`ApiGlobalUserInvalidName`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserInvalidName.md) | [`ApiGlobalUserMissingId`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingId.md) Defined in: [extensions/centralauth.ts:369](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L369) One `list=globalusers` row: either a found account ([ApiGlobalUserFound](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md)) or a marker for a name/id that is unknown (`missing`), syntactically invalid (`invalid`), or hidden from the requester (`missing` again — hidden accounts are reported as absent). --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md --- > 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: ApiSetGlobalAccountStatusFailedResponse Defined in: [extensions/centralauth.ts:179](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L179) In-band failure of `action=setglobalaccountstatus`: the unchanged state object is returned without `reason`, alongside the root `error` list as a nested [ApiSpecMessage](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md) list rather than a standard `ApiErrorResponse`. Use `ApiResponseWith` to model either outcome. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### error > **error**: [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md)\[]\[] Defined in: [extensions/centralauth.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L184) In-band failure messages. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### setglobalaccountstatus > **setglobalaccountstatus**: [`ApiSetGlobalAccountStatusState`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md) Defined in: [extensions/centralauth.ts:181](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L181) The unchanged lock / hide state after the failed call. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResponse.md --- > 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: ApiSetGlobalAccountStatusResponse Defined in: [extensions/centralauth.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L168) Successful response of `action=setglobalaccountstatus`. A failed lock/hide returns the unchanged state (without `reason`) plus an in-band root `error` — see [ApiSetGlobalAccountStatusFailedResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### setglobalaccountstatus > **setglobalaccountstatus**: [`ApiSetGlobalAccountStatusResult`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md) Defined in: [extensions/centralauth.ts:170](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L170) Result of `action=setglobalaccountstatus`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md --- > 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: ApiSetGlobalAccountStatusResult Defined in: [extensions/centralauth.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L158) Result object of `action=setglobalaccountstatus` (its own token type POST): the new lock / hide state of a global account plus the reason echoed back. ## Extends - [`ApiSetGlobalAccountStatusState`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md) ## Properties ### hidden > **hidden**: `""` | `"lists"` | `"suppressed"` Defined in: [extensions/centralauth.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L151) Suppression level after the call: visible (`""`), hidden from lists, or fully suppressed. #### Inherited from [`ApiSetGlobalAccountStatusState`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md).[`hidden`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md#hidden) *** ### locked > **locked**: `boolean` Defined in: [extensions/centralauth.ts:145](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L145) Whether the account is locked after the call. #### Inherited from [`ApiSetGlobalAccountStatusState`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md).[`locked`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md#locked) *** ### reason > **reason**: `string` | `null` Defined in: [extensions/centralauth.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L160) The reason passed to the call; `null` when none was given. *** ### user > **user**: `string` Defined in: [extensions/centralauth.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L142) The affected global account name. #### Inherited from [`ApiSetGlobalAccountStatusState`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md).[`user`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md#user) --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md --- > 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: ApiSetGlobalAccountStatusState Defined in: [extensions/centralauth.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L140) The lock / hide state of a global account, written by `action=setglobalaccountstatus` on every outcome. The success response extends it with [ApiSetGlobalAccountStatusResult.reason](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md#reason); a failed call reports only this state, alongside the in-band root `error` list. ## Extended by - [`ApiSetGlobalAccountStatusResult`](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md) ## Properties ### hidden > **hidden**: `""` | `"lists"` | `"suppressed"` Defined in: [extensions/centralauth.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L151) Suppression level after the call: visible (`""`), hidden from lists, or fully suppressed. *** ### locked > **locked**: `boolean` Defined in: [extensions/centralauth.ts:145](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L145) Whether the account is locked after the call. *** ### user > **user**: `string` Defined in: [extensions/centralauth.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L142) The affected global account name. --- url: https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiWikiSet.md --- > 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: ApiWikiSet Defined in: [extensions/centralauth.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L83) One `list=wikisets` entry: a named wiki set (a list of wikis used for global group restrictions). The key set is farm-configured. ## Properties ### id > **id**: `string` | `number` Defined in: [extensions/centralauth.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L88) Wiki set id. A string up to MediaWiki 1.45 (fv2 passes the raw `ws_id` column through), a number from 1.46 once the value is cast to int. *** ### name > **name**: `string` Defined in: [extensions/centralauth.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L91) Wiki set name. *** ### type? > `optional` **type?**: `"optin"` | `"optout"` Defined in: [extensions/centralauth.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L94) Whether the set lists included (`optin`) or excluded (`optout`) wikis. *** ### wikisincluded? > `optional` **wikisincluded?**: `string`\[] Defined in: [extensions/centralauth.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L100) Wikis the set covers (for `optin`) or does not cover (for `optout`), `[]` when none. Present whenever `wsprop` includes it. *** ### wikisnotincluded? > `optional` **wikisnotincluded?**: `string`\[] Defined in: [extensions/centralauth.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/centralauth.ts#L106) The complement of [ApiWikiSet.wikisincluded](#wikisincluded) against all known wikis, `[]` when none. Present whenever `wsprop` includes it. --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/overview.md --- > 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. # CheckUser ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiCheckUserActionRow](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserActionRow.md) | One action row of `curequest=actions` (deprecated alias `edits`). | | [ApiCheckUserIpRow](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserIpRow.md) | One IP row of `curequest=userips`: an IP the target user edited from. | | [ApiCheckUserIpUserRow](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserIpUserRow.md) | One user row of `curequest=ipusers`: an account that edited from the target IP. | | [ApiCheckUserLogEntry](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserLogEntry.md) | One entry of `list=checkuserlog`. | | [ApiQueryCheckUserFormattedBlockInfoResult](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserFormattedBlockInfoResult.md) | The `checkuserformattedblockinfo` object: the sitewide-block status of the requesting user, for clients that need to explain API failures caused by their own block. | | [ApiQueryCheckUserLogResult](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserLogResult.md) | The `checkuserlog` object of a `list=checkuserlog` response. | | [ApiQueryCheckUserResult](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserResult.md) | The `checkuser` object: shaped by `curequest`, one key per request mode. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserActionRow.md --- > 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: ApiCheckUserActionRow Defined in: [extensions/checkuser.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L54) One action row of `curequest=actions` (deprecated alias `edits`). ## Properties ### agent > **agent**: `string` | `null` Defined in: [extensions/checkuser.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L80) User-Agent string of the request, or `null` (not omitted under fv2) when none was recorded. *** ### ip > **ip**: `string` | `null` Defined in: [extensions/checkuser.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L74) IP address the action was made from; `null` when none was recorded. *** ### minor? > `optional` **minor?**: `"m"` Defined in: [extensions/checkuser.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L86) `m` for minor edits; the key is absent otherwise. *** ### ns > **ns**: `number` Defined in: [extensions/checkuser.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L59) Namespace of the affected page. *** ### summary? > `optional` **summary?**: `string` Defined in: [extensions/checkuser.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L83) Edit summary / log action text, when there is one. *** ### timestamp > **timestamp**: `string` Defined in: [extensions/checkuser.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L56) When the action happened. *** ### title > **title**: `string` Defined in: [extensions/checkuser.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L65) Title (DB key form with underscores) of the affected page; a user page whose name is hidden comes back as a `rev-deleted-user` placeholder. *** ### user > **user**: `string` | `null` Defined in: [extensions/checkuser.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L71) Performing user name; IP for anonymous actions, or a `rev-deleted-user` placeholder. `null` on rows recorded with neither an actor nor an IP. *** ### xff? > `optional` **xff?**: `string` Defined in: [extensions/checkuser.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L92) X-Forwarded-For chain of the request, when one was recorded. Reported independently of `cuxff`, which only decides what the lookup matches on. --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserIpRow.md --- > 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: ApiCheckUserIpRow Defined in: [extensions/checkuser.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L35) One IP row of `curequest=userips`: an IP the target user edited from. ## Properties ### address > **address**: `string` Defined in: [extensions/checkuser.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L50) The IP address; `""` for a row recorded without one. *** ### editcount > **editcount**: `number` Defined in: [extensions/checkuser.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L40) Number of edits made from this IP within the requested time frame. *** ### end > **end**: `string` Defined in: [extensions/checkuser.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L37) Last edit from this IP. *** ### start? > `optional` **start?**: `string` Defined in: [extensions/checkuser.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L45) First edit from this IP; only present once the IP has more than one edit. --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserIpUserRow.md --- > 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: ApiCheckUserIpUserRow Defined in: [extensions/checkuser.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L96) One user row of `curequest=ipusers`: an account that edited from the target IP. ## Properties ### agents > **agents**: (`string` | `null`)\[] Defined in: [extensions/checkuser.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L112) Distinct User-Agent strings seen, entries may be `null` when unrecorded. *** ### editcount > **editcount**: `number` Defined in: [extensions/checkuser.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L101) Number of edits by this user from the target IP within the time frame. *** ### end > **end**: `string` Defined in: [extensions/checkuser.ts:98](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L98) Last edit by this user from the target IP. *** ### ips > **ips**: (`string` | `null`)\[] Defined in: [extensions/checkuser.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L109) Distinct IPs the user edited from — one for a single-IP target, but several when the target is a CIDR range or `cuxff` was passed (rows are then matched on XFF while the reported address stays the recorded IP). An entry is `null` when its row was recorded without an IP. *** ### name > **name**: `string` Defined in: [extensions/checkuser.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L124) User name, or a `rev-deleted-user` placeholder when suppressed; `""` for rows recorded with neither an actor nor an IP. *** ### start? > `optional` **start?**: `string` Defined in: [extensions/checkuser.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L118) First edit by this user from the target IP; only present once the user has more than one edit. --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserLogEntry.md --- > 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: ApiCheckUserLogEntry Defined in: [extensions/checkuser.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L146) One entry of `list=checkuserlog`. ## Properties ### checkuser > **checkuser**: `string` Defined in: [extensions/checkuser.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L151) The checkuser who ran the lookup. *** ### reason > **reason**: `string` Defined in: [extensions/checkuser.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L160) Check reason, prefixed `API: ` for lookups made through the API. *** ### target > **target**: `string` Defined in: [extensions/checkuser.ts:163](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L163) Looked-up target (user name or IP). *** ### timestamp > **timestamp**: `string` Defined in: [extensions/checkuser.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L148) When the check was performed. *** ### type > **type**: `string` Defined in: [extensions/checkuser.ts:157](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L157) Lookup type, e.g. `userips`, `useredits`, `ipusers`, `ipedits`, `ipedits-xff`, `ipusers-xff`, `investigate`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserFormattedBlockInfoResult.md --- > 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: ApiQueryCheckUserFormattedBlockInfoResult Defined in: [extensions/checkuser.ts:179](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L179) The `checkuserformattedblockinfo` object: the sitewide-block status of the requesting user, for clients that need to explain API failures caused by their own block. ## Since MediaWiki 1.44 ## Properties ### details > **details**: `string` | `null` Defined in: [extensions/checkuser.ts:185](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L185) Rendered (HTML) block message explaining the sitewide block; `null` when the requesting user is not sitewide-blocked. Partial blocks and blocks on other users do not appear here. --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserLogResult.md --- > 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: ApiQueryCheckUserLogResult Defined in: [extensions/checkuser.ts:167](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L167) The `checkuserlog` object of a `list=checkuserlog` response. ## Properties ### entries? > `optional` **entries?**: [`ApiCheckUserLogEntry`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserLogEntry.md)\[] Defined in: [extensions/checkuser.ts:169](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L169) Log entries, ordered per `culdir` (default newest first). --- url: https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiQueryCheckUserResult.md --- > 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: ApiQueryCheckUserResult Defined in: [extensions/checkuser.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L128) The `checkuser` object: shaped by `curequest`, one key per request mode. ## Properties ### edits? > `optional` **edits?**: [`ApiCheckUserActionRow`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserActionRow.md)\[] Defined in: [extensions/checkuser.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L139) `curequest=actions`, and its deprecated alias `curequest=edits` (which only draws a deprecation warning): individual actions by a user / IP. #### Since MediaWiki 1.42 for the `actions` spelling; earlier releases accept only `edits`. *** ### ipusers? > `optional` **ipusers?**: [`ApiCheckUserIpUserRow`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserIpUserRow.md)\[] Defined in: [extensions/checkuser.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L142) `curequest=ipusers`: users who edited from an IP or range. *** ### userips? > `optional` **userips?**: [`ApiCheckUserIpRow`](https://types-mediawiki-response.pages.dev/api/extensions/checkuser/ApiCheckUserIpRow.md)\[] Defined in: [extensions/checkuser.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/checkuser.ts#L130) `curequest=userips`: IPs a user edited from. --- url: https://types-mediawiki-response.pages.dev/api/extensions/description/overview.md --- > 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. # Wikibase Client ## Type Aliases | Type Alias | Description | | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | [DescriptionSource](https://types-mediawiki-response.pages.dev/api/extensions/description/DescriptionSource.md) | Where the description came from. Open union for forward compatibility. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/description/DescriptionSource.md --- > 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. # Type Alias: DescriptionSource > **DescriptionSource** = `"local"` | `"central"` | `string` & `object` Defined in: [extensions/description.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/description.ts#L17) Where the description came from. Open union for forward compatibility. --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/overview.md --- > 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. # DiscussionTools ## Interfaces | Interface | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiDiscussionToolsComment](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsComment.md) | One node of a reply/indent tree (`prop=threaditemshtml`). | | [ApiDiscussionToolsCommentForDiff](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCommentForDiff.md) | One comment item in a `discussiontoolscompare` diff: the thread-item shape (see `ApiDiscussionToolsComment`) with `replies` flattened to comment ids and the heading references appended. | | [ApiDiscussionToolsCompareResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCompareResponse.md) | Response of `action=discussiontoolscompare` (comment-level diff of two revisions). | | [ApiDiscussionToolsEditResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsEditResponse.md) | Response of `action=discussiontoolsedit`. | | [ApiDiscussionToolsFindCommentResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFindCommentResponse.md) | Response of `action=discussiontoolsfindcomment` (a list of candidates). | | [ApiDiscussionToolsFoundComment](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFoundComment.md) | One candidate returned by `action=discussiontoolsfindcomment`. | | [ApiDiscussionToolsGetSubscriptionsResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsGetSubscriptionsResponse.md) | Response of `action=discussiontoolsgetsubscriptions`. The map is keyed by comment **name** (the same strings as the `commentname` request parameter); each value is `0` (unsubscribed), `1` (subscribed) or `2` (auto-subscribed) — numeric, not boolean. | | [ApiDiscussionToolsPageInfoResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPageInfoResponse.md) | Response of `action=discussiontoolspageinfo`. | | [ApiDiscussionToolsPreviewResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPreviewResponse.md) | Response of `action=discussiontoolspreview`. | | [ApiDiscussionToolsSubscribeResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsSubscribeResponse.md) | Response of `action=discussiontoolssubscribe`. | | [ApiDiscussionToolsThankResponse](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsThankResponse.md) | Response of `action=discussiontoolsthank`. The module inherits the Thanks extension's result: a root-level `result` key, not one named after the module. | | [ApiDiscussionToolsTranscludedFrom](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsTranscludedFrom.md) | `prop=transcludedfrom`: whether each comment is a transclusion target here. Keyed by comment id **and** name; `false` when the content is local, `true` when transcluded but the source could not be determined, otherwise the source page title. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsComment.md --- > 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: ApiDiscussionToolsComment Defined in: [extensions/discussiontools.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L37) One node of a reply/indent tree (`prop=threaditemshtml`). ## Properties ### author? > `optional` **author?**: `string` Defined in: [extensions/discussiontools.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L61) Who wrote the comment. *** ### authorCount? > `optional` **authorCount?**: `number` Defined in: [extensions/discussiontools.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L94) Distinct authors below this heading. Headings only. #### Since MediaWiki 1.45 *** ### commentCount? > `optional` **commentCount?**: `number` Defined in: [extensions/discussiontools.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L87) Number of comments below this heading. Headings only (`prop=threaditemshtml`). #### Since MediaWiki 1.45 *** ### displayName? > `optional` **displayName?**: `string` Defined in: [extensions/discussiontools.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L64) Display name shown in the signature, when it differs from [author](#author). *** ### headingLevel? > `optional` **headingLevel?**: `number` | `null` Defined in: [extensions/discussiontools.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L52) Heading level as written in wikitext (`==` → 2), headings only; `null` for placeholder headings. *** ### html? > `optional` **html?**: `string` Defined in: [extensions/discussiontools.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L73) Rendered HTML of this comment. *** ### id > **id**: `string` Defined in: [extensions/discussiontools.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L39) Comment id, e.g. `h-Example_topic-20240115083000`. *** ### latestReply? > `optional` **latestReply?**: `ApiDiscussionToolsComment` | `null` Defined in: [extensions/discussiontools.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L111) The most recent reply, serialized as a comment item without its `replies`; `null` when there is none. Headings only, and only with `threaditemsflags=activity` (alongside `prop=threaditemshtml`). #### Since MediaWiki 1.46 *** ### latestReplyTimestamp? > `optional` **latestReplyTimestamp?**: `string` | `null` Defined in: [extensions/discussiontools.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L102) Timestamp of the latest reply under this heading, or `null` when there is none. Headings only. #### Since MediaWiki 1.45 *** ### level? > `optional` **level?**: `number` Defined in: [extensions/discussiontools.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L49) Rendering level of the heading (`0` for the topic itself). *** ### name? > `optional` **name?**: `string` Defined in: [extensions/discussiontools.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L46) Comment name — headings only (`h--`, where `` is the thread starter, or bare `h-` for an empty section); comment items do not serialize a name. *** ### oldestReply? > `optional` **oldestReply?**: `ApiDiscussionToolsComment` | `null` Defined in: [extensions/discussiontools.ts:120](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L120) The earliest reply, same serialization as [latestReply](#latestreply); `null` when there is none. Headings only, and only with `threaditemsflags=activity` (alongside `prop=threaditemshtml`). #### Since MediaWiki 1.46 *** ### othercontent? > `optional` **othercontent?**: `string` Defined in: [extensions/discussiontools.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L76) HTML of the content between an empty section's heading and the next one; headings only. *** ### replies? > `optional` **replies?**: `ApiDiscussionToolsComment`\[] Defined in: [extensions/discussiontools.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L79) Nested replies (same shape, recursively). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/discussiontools.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L67) When it was signed. *** ### type > **type**: `string` Defined in: [extensions/discussiontools.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L70) Comment type, e.g. `comment`, `heading`. Open union. *** ### uneditableSection? > `optional` **uneditableSection?**: `true` Defined in: [extensions/discussiontools.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L58) The heading opens a section that cannot be edited here (no edit-section link was rendered); headings only. --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCommentForDiff.md --- > 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: ApiDiscussionToolsCommentForDiff Defined in: [extensions/discussiontools.ts:226](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L226) One comment item in a `discussiontoolscompare` diff: the thread-item shape (see `ApiDiscussionToolsComment`) with `replies` flattened to comment ids and the heading references appended. ## Properties ### author? > `optional` **author?**: `string` Defined in: [extensions/discussiontools.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L243) Who wrote the comment. *** ### headingId? > `optional` **headingId?**: `string` Defined in: [extensions/discussiontools.ts:246](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L246) Id of the heading the comment sits under. *** ### id? > `optional` **id?**: `string` Defined in: [extensions/discussiontools.ts:228](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L228) Comment id. *** ### level? > `optional` **level?**: `number` Defined in: [extensions/discussiontools.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L234) Rendering level. *** ### replies? > `optional` **replies?**: `string`\[] Defined in: [extensions/discussiontools.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L237) Ids of nested replies (shallow serialization). *** ### subscribableHeadingId? > `optional` **subscribableHeadingId?**: `string` | `null` Defined in: [extensions/discussiontools.ts:249](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L249) Id of the nearest subscribable heading; `null` when there is none. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/discussiontools.ts:240](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L240) When it was signed — the compact id/name timestamp form (`YYYYMMDDHHMMSS`); comments predating 2022-07 are ISO 8601 instead. *** ### type? > `optional` **type?**: `string` Defined in: [extensions/discussiontools.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L231) Comment type, e.g. `comment`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCompareResponse.md --- > 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: ApiDiscussionToolsCompareResponse Defined in: [extensions/discussiontools.ts:253](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L253) Response of `action=discussiontoolscompare` (comment-level diff of two revisions). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### discussiontoolscompare > **discussiontoolscompare**: `object` Defined in: [extensions/discussiontools.ts:255](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L255) Result of `action=discussiontoolscompare`. #### addedcomments? > `optional` **addedcomments?**: [`ApiDiscussionToolsCommentForDiff`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCommentForDiff.md)\[] Comments present only in the right revision. #### fromrevid? > `optional` **fromrevid?**: `number` Left revision id. #### fromtitle? > `optional` **fromtitle?**: `string` Page title of the left revision. #### removedcomments? > `optional` **removedcomments?**: [`ApiDiscussionToolsCommentForDiff`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsCommentForDiff.md)\[] Comments present only in the left revision. #### torevid? > `optional` **torevid?**: `number` Right revision id. #### totitle? > `optional` **totitle?**: `string` Page title of the right revision. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsEditResponse.md --- > 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: ApiDiscussionToolsEditResponse Defined in: [extensions/discussiontools.ts:286](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L286) Response of `action=discussiontoolsedit`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### discussiontoolsedit > **discussiontoolsedit**: `object` Defined in: [extensions/discussiontools.ts:288](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L288) Result of `action=discussiontoolsedit`. #### categorieshtml? > `optional` **categorieshtml?**: `string` Category HTML added by the saved comment. #### content? > `optional` **content?**: `string` Rendered HTML of the saved comment area. #### contentSub? > `optional` **contentSub?**: `string` Page subtitle (parsed HTML), copied from the underlying `action=parse` output. #### displayTitleHtml? > `optional` **displayTitleHtml?**: `string` Display title, HTML form. #### isRedirect? > `optional` **isRedirect?**: `string` Empty string for a normal page. The module copies `action=parse`'s field, which is a `Flag`-like empty string under fv2 rather than a boolean. #### jsconfigvars? > `optional` **jsconfigvars?**: `Record`\<`string`, `unknown`> ResourceLoader config variables (includes the thread model). #### lastModified? > `optional` **lastModified?**: [`ApiLastModified`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiLastModified.md) When the page last changed, in display parts. #### modules? > `optional` **modules?**: `string`\[] ResourceLoader module names to load. #### newrevid? > `optional` **newrevid?**: `number` New revision id; absent when nothing was saved. #### nocontent? > `optional` **nocontent?**: `true` `true` when the content above was withheld (the `nocontent` request parameter) but had to be fetched internally anyway. ##### Since MediaWiki 1.42 #### result? > `optional` **result?**: `"error"` | `"success"` Outcome of the delegated `action=visualeditoredit` call: `success` when the comment was saved, `error` when the save was rejected. #### sections? > `optional` **sections?**: `unknown`\[] Section list after the edit. #### tempusercreated? > `optional` **tempusercreated?**: `true` `true` when a temporary account was created by this edit. #### tempusercreatedredirect? > `optional` **tempusercreatedredirect?**: `string` Redirect URL for a just-created temporary account, when one applies. #### watched? > `optional` **watched?**: `boolean` Whether the user now watches the page. #### watchlistexpiry? > `optional` **watchlistexpiry?**: [`WatchlistExpiry`](https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md) When that watch expires; `null` for a permanent watch. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFindCommentResponse.md --- > 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: ApiDiscussionToolsFindCommentResponse Defined in: [extensions/discussiontools.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L180) Response of `action=discussiontoolsfindcomment` (a list of candidates). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### discussiontoolsfindcomment > **discussiontoolsfindcomment**: [`ApiDiscussionToolsFoundComment`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFoundComment.md)\[] Defined in: [extensions/discussiontools.ts:182](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L182) Result of `action=discussiontoolsfindcomment`; one entry per candidate comment. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsFoundComment.md --- > 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: ApiDiscussionToolsFoundComment Defined in: [extensions/discussiontools.ts:147](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L147) One candidate returned by `action=discussiontoolsfindcomment`. ## Properties ### couldredirect? > `optional` **couldredirect?**: `boolean` Defined in: [extensions/discussiontools.ts:169](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L169) Whether the request could be redirected to a permalink. Absent in the 1.41 `findcomment` release, which unset it; emitted from 1.42. #### Since MediaWiki 1.42 *** ### id > **id**: `string` Defined in: [extensions/discussiontools.ts:149](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L149) Canonical comment id. *** ### matchedby > **matchedby**: `string` & `object` | `"name"` | `"id"` | `"heading"` Defined in: [extensions/discussiontools.ts:161](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L161) How the lookup matched: `id`, `name` or `heading`. *** ### name > **name**: `string` Defined in: [extensions/discussiontools.ts:152](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L152) Canonical comment name. *** ### oldid > **oldid**: `number` | `null` Defined in: [extensions/discussiontools.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L158) Revision id of the permalink; `null` when the revision is the current one. *** ### shouldredirect? > `optional` **shouldredirect?**: `boolean` Defined in: [extensions/discussiontools.ts:176](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L176) Whether it should be (the target differs from what was asked). #### Since MediaWiki 1.41 *** ### title > **title**: `string` Defined in: [extensions/discussiontools.ts:155](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L155) Page the comment lives on. --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsGetSubscriptionsResponse.md --- > 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: ApiDiscussionToolsGetSubscriptionsResponse Defined in: [extensions/discussiontools.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L191) Response of `action=discussiontoolsgetsubscriptions`. The map is keyed by comment **name** (the same strings as the `commentname` request parameter); each value is `0` (unsubscribed), `1` (subscribed) or `2` (auto-subscribed) — numeric, not boolean. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### subscriptions > **subscriptions**: `Record`\<`string`, `number`> Defined in: [extensions/discussiontools.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L193) Subscription state per comment keyed by name: `0` unsubscribed, `1` subscribed, `2` auto-subscribed. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPageInfoResponse.md --- > 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: ApiDiscussionToolsPageInfoResponse Defined in: [extensions/discussiontools.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L135) Response of `action=discussiontoolspageinfo`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### discussiontoolspageinfo > **discussiontoolspageinfo**: `object` Defined in: [extensions/discussiontools.ts:137](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L137) Result of `action=discussiontoolspageinfo`. #### threaditemshtml? > `optional` **threaditemshtml?**: [`ApiDiscussionToolsComment`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsComment.md)\[] Parsed reply tree. `prop=threaditemshtml`. #### transcludedfrom? > `optional` **transcludedfrom?**: [`ApiDiscussionToolsTranscludedFrom`](https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsTranscludedFrom.md) Per-comment transclusion map (local vs transcluded, with source title). `prop=transcludedfrom`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsPreviewResponse.md --- > 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: ApiDiscussionToolsPreviewResponse Defined in: [extensions/discussiontools.ts:277](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L277) Response of `action=discussiontoolspreview`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### discussiontoolspreview > **discussiontoolspreview**: `object` Defined in: [extensions/discussiontools.ts:279](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L279) Result of `action=discussiontoolspreview`. #### parse? > `optional` **parse?**: [`ApiParse`](https://types-mediawiki-response.pages.dev/api/core/ApiParse.md) The parsed preview, same shape as an `action=parse` payload. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsSubscribeResponse.md --- > 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: ApiDiscussionToolsSubscribeResponse Defined in: [extensions/discussiontools.ts:197](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L197) Response of `action=discussiontoolssubscribe`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### discussiontoolssubscribe > **discussiontoolssubscribe**: `object` Defined in: [extensions/discussiontools.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L199) Result of `action=discussiontoolssubscribe`. #### commentname > **commentname**: `string` Canonical comment name the subscription applies to. #### page > **page**: `string` Page the comment is on. #### subscribe > **subscribe**: `boolean` Requested state, echoed back. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsThankResponse.md --- > 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: ApiDiscussionToolsThankResponse Defined in: [extensions/discussiontools.ts:216](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L216) Response of `action=discussiontoolsthank`. The module inherits the Thanks extension's result: a root-level `result` key, not one named after the module. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### result? > `optional` **result?**: [`ApiThankResult`](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResult.md) Defined in: [extensions/discussiontools.ts:218](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L218) The thanks result, the same shape as `action=thank` ([ApiThankResult](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResult.md)). *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/discussiontools/ApiDiscussionToolsTranscludedFrom.md --- > 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: ApiDiscussionToolsTranscludedFrom Defined in: [extensions/discussiontools.ts:129](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/discussiontools.ts#L129) `prop=transcludedfrom`: whether each comment is a transclusion target here. Keyed by comment id **and** name; `false` when the content is local, `true` when transcluded but the source could not be determined, otherwise the source page title. ## Indexable > \[`commentIdOrName`: `string`]: `string` | `boolean` | `undefined` State for the comment the id or name key refers to. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/overview.md --- > 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. # Echo / Notifications ## Interfaces | Interface | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiEchoAgent](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoAgent.md) | The user whose action triggered a notification. | | [ApiEchoCreateEventResponse](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoCreateEventResponse.md) | Response of `action=echocreateevent`. Shape of the `ApiEchoCreateEvent` module (off by default — `$wgEchoEnableApiEvents`). | | [ApiEchoMuteResponse](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoMuteResponse.md) | Response of `action=echomute`. The module writes a plain status **string** rather than a wrapper object. | | [ApiEchoNotification](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotification.md) | One notification row (`meta=notifications`, `notprop=list`). | | [ApiEchoNotificationCount](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationCount.md) | A notification count: numeric `rawcount` plus a localized `count` string. | | [ApiEchoNotificationLink](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationLink.md) | One link attached to a model-format notification. | | [ApiEchoNotificationModel](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationModel.md) | Structured payload a notification's presenter exposes (`notformat=model`). | | [ApiEchoNotificationSection](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md) | A `count` / `list` slice, either flat or grouped per section. | | [ApiEchoPushSubscriptionsResponse](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoPushSubscriptionsResponse.md) | Responses of `action=echopushsubscriptions`: the `command` value is the response key (`create` or `delete`). The module is experimental and only registered when `$wgEchoEnablePush` is on. | | [ApiEchoTimestamp](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoTimestamp.md) | Every timestamp form Echo attaches to a notification (`timestamp=` object). | | [ApiEchoTitle](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoTitle.md) | The title of the page a notification points at. | | [ApiEchoUnreadPage](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadPage.md) | Per-wiki unread summary keyed by page title. | | [ApiEchoUnreadSource](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadSource.md) | One wiki's unread-notification summary inside `unreadnotificationpages`. | | [ApiEchoUnreadWiki](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadWiki.md) | One wiki's entry in `meta=unreadnotificationpages` (keyed by wiki id). | | [ApiQueryEchoArticleReminder](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoArticleReminder.md) | The `echoarticlereminder` object (returned under `query`). The module is only registered when `$wgAllowArticleReminderNotification` is on. | | [ApiQueryEchoMarkRead](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoMarkRead.md) | The `echomarkread` object (returned under `query` by `action=echomarkread`). | | [ApiQueryEchoMarkSeen](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoMarkSeen.md) | The `echomarkseen` object (returned under `query` by `action=echomarkseen`). | | [ApiQueryEchoNotifications](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoNotifications.md) | The `notifications` object (returned under `query` by `meta=notifications`). | | [ApiQueryEchoUnreadPages](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoUnreadPages.md) | The `unreadnotificationpages` object: a map from wiki id (e.g. `mediawikiwiki`) to that wiki's unread summary. A PHP map, so an empty result serializes as `[]`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoAgent.md --- > 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: ApiEchoAgent Defined in: [extensions/echo.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L131) The user whose action triggered a notification. ## Properties ### id? > `optional` **id?**: `number` Defined in: [extensions/echo.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L133) User id. *** ### name? > `optional` **name?**: `string` Defined in: [extensions/echo.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L136) User name. *** ### userhidden? > `optional` **userhidden?**: `""` Defined in: [extensions/echo.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L142) Suppression marker: when the agent's identity is hidden, the agent object collapses to `{ userhidden: "" }` and carries no other keys. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoCreateEventResponse.md --- > 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: ApiEchoCreateEventResponse Defined in: [extensions/echo.ts:350](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L350) Response of `action=echocreateevent`. Shape of the `ApiEchoCreateEvent` module (off by default — `$wgEchoEnableApiEvents`). ## Since MediaWiki 1.43 ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### echocreateevent > **echocreateevent**: `object` Defined in: [extensions/echo.ts:352](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L352) Result of `action=echocreateevent`. #### result? > `optional` **result?**: `"success"` Success sentinel; a rejected call comes back as a top-level error. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoMuteResponse.md --- > 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: ApiEchoMuteResponse Defined in: [extensions/echo.ts:339](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L339) Response of `action=echomute`. The module writes a plain status **string** rather than a wrapper object. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### echomute > **echomute**: `"success"` Defined in: [extensions/echo.ts:341](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L341) Success sentinel; a rejected call comes back as a top-level error. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotification.md --- > 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: ApiEchoNotification Defined in: [extensions/echo.ts:185](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L185) One notification row (`meta=notifications`, `notprop=list`). ## Properties ### \*? > `optional` **\*?**: `string` | [`ApiEchoNotificationModel`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationModel.md) Defined in: [extensions/echo.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L231) Rendered notification body, present whenever `notformat` is given. The shape depends on the format: `model` returns a structured [ApiEchoNotificationModel](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationModel.md) object, the other formats (`special`, plus the deprecated `flyout`/`html`) return an HTML string. *** ### agent? > `optional` **agent?**: [`ApiEchoAgent`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoAgent.md) Defined in: [extensions/echo.ts:214](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L214) Actor that triggered it. *** ### bundledIds? > `optional` **bundledIds?**: `number`\[] Defined in: [extensions/echo.ts:205](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L205) Ids of the notifications bundled into this one (bundled notifications present). *** ### bundledNotifications? > `optional` **bundledNotifications?**: `ApiEchoNotification`\[] Defined in: [extensions/echo.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L237) The notifications bundled into this one, formatted like the parent row (expandable bundles; requires `notformat`). *** ### category? > `optional` **category?**: `string` Defined in: [extensions/echo.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L196) Event category, usually mirrors [type](#type). *** ### id? > `optional` **id?**: `number` Defined in: [extensions/echo.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L190) Notification id; feed it back to `action=echomarkread` or `action=echomute`. *** ### read? > `optional` **read?**: `string` Defined in: [extensions/echo.ts:220](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L220) When the notification was marked read (MediaWiki 14-digit timestamp). *** ### revid? > `optional` **revid?**: `number` Defined in: [extensions/echo.ts:217](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L217) Revision id associated with the event. *** ### section? > `optional` **section?**: `string` & `object` | `"alert"` | `"message"` Defined in: [extensions/echo.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L199) Section the notification lives in. *** ### targetpages? > `optional` **targetpages?**: `number`\[] Defined in: [extensions/echo.ts:223](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L223) Page ids the notification targets (empty array when there are none). *** ### timestamp? > `optional` **timestamp?**: [`ApiEchoTimestamp`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoTimestamp.md) Defined in: [extensions/echo.ts:202](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L202) Timestamp in every form Echo publishes. *** ### title? > `optional` **title?**: [`ApiEchoTitle`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoTitle.md) Defined in: [extensions/echo.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L211) Target page of the notification. *** ### type? > `optional` **type?**: `string` Defined in: [extensions/echo.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L193) Event type, e.g. `mention`, `thank-you-edit`, `page-linked`. Open union. *** ### variant? > `optional` **variant?**: `string` Defined in: [extensions/echo.ts:208](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L208) Presentation variant of the event, when the event carries one. *** ### wiki? > `optional` **wiki?**: `string` Defined in: [extensions/echo.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L187) Wiki the notification came from — cross-wiki notifications carry other sites. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationCount.md --- > 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: ApiEchoNotificationCount Defined in: [extensions/echo.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L38) A notification count: numeric `rawcount` plus a localized `count` string. ## Properties ### count > **count**: `string` Defined in: [extensions/echo.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L43) Count formatted for display (a string; e.g. `"0"`, `"1,234"`). *** ### rawcount > **rawcount**: `number` Defined in: [extensions/echo.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L40) Raw numeric count. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationLink.md --- > 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: ApiEchoNotificationLink Defined in: [extensions/echo.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L146) One link attached to a model-format notification. ## Properties ### label? > `optional` **label?**: `string` Defined in: [extensions/echo.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L148) Link text. *** ### url? > `optional` **url?**: `string` Defined in: [extensions/echo.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L151) Target URL. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationModel.md --- > 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: ApiEchoNotificationModel Defined in: [extensions/echo.ts:155](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L155) Structured payload a notification's presenter exposes (`notformat=model`). ## Properties ### body? > `optional` **body?**: `string` Defined in: [extensions/echo.ts:157](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L157) Rendered body HTML. *** ### bundledIds? > `optional` **bundledIds?**: `number`\[] Defined in: [extensions/echo.ts:181](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L181) Event ids this notification bundles, when it stands in for a group. *** ### compactHeader? > `optional` **compactHeader?**: `string` Defined in: [extensions/echo.ts:163](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L163) Condensed header for the flyout. *** ### header? > `optional` **header?**: `string` Defined in: [extensions/echo.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L160) Short header line. *** ### icon? > `optional` **icon?**: `string` Defined in: [extensions/echo.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L166) Icon name from the Echo icon registry. *** ### iconUrl > **iconUrl**: `string` Defined in: [extensions/echo.ts:169](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L169) Icon URL. *** ### links? > `optional` **links?**: `object` Defined in: [extensions/echo.ts:172](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L172) Primary and secondary action links. #### primary? > `optional` **primary?**: [`ApiEchoNotificationLink`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationLink.md) The notification's main action. #### secondary? > `optional` **secondary?**: [`ApiEchoNotificationLink`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationLink.md)\[] Secondary actions offered with it. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md --- > 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: ApiEchoNotificationSection Defined in: [extensions/echo.ts:241](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L241) A `count` / `list` slice, either flat or grouped per section. ## Extended by - [`ApiQueryEchoNotifications`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoNotifications.md) ## Properties ### continue? > `optional` **continue?**: `string` | `null` Defined in: [extensions/echo.ts:246](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L246) Continue cursor for this section, or `null` when the list is complete. *** ### count? > `optional` **count?**: `string` Defined in: [extensions/echo.ts:252](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L252) Unread count formatted for display. *** ### list? > `optional` **list?**: [`ApiEchoNotification`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotification.md)\[] Defined in: [extensions/echo.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L243) Notification rows. *** ### rawcount? > `optional` **rawcount?**: `number` Defined in: [extensions/echo.ts:249](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L249) Raw numeric unread count. *** ### seenTime? > `optional` **seenTime?**: `string` | `Record`\<`string`, `string`> Defined in: [extensions/echo.ts:259](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L259) Last-seen timestamp. At the top level of `notifications` (flat mode) this is a map keyed by section name; inside a per-section object (grouped mode, `notgroupbysection=1`) it is a single ISO timestamp. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoPushSubscriptionsResponse.md --- > 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: ApiEchoPushSubscriptionsResponse Defined in: [extensions/echo.ts:372](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L372) Responses of `action=echopushsubscriptions`: the `command` value is the response key (`create` or `delete`). The module is experimental and only registered when `$wgEchoEnablePush` is on. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### create? > `optional` **create?**: `object` Defined in: [extensions/echo.ts:374](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L374) `command=create` — the subscription was stored. #### result? > `optional` **result?**: `"Success"` Success sentinel; a rejected call comes back as a top-level error. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### delete? > `optional` **delete?**: `object` Defined in: [extensions/echo.ts:380](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L380) `command=delete` — the subscription was removed. #### result? > `optional` **result?**: `"Success"` Success sentinel; a rejected call comes back as a top-level error. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoTimestamp.md --- > 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: ApiEchoTimestamp Defined in: [extensions/echo.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L92) Every timestamp form Echo attaches to a notification (`timestamp=` object). ## Properties ### date? > `optional` **date?**: `string` Defined in: [extensions/echo.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L112) Localized date-group header: `Today`/`Yesterday`, or a pretty date such as `May 10` for notifications older than 48 hours. *** ### mw? > `optional` **mw?**: `string` Defined in: [extensions/echo.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L106) MediaWiki 14-digit timestamp in the user's local timezone (`utcmw` is the UTC one). *** ### unix? > `optional` **unix?**: `string` Defined in: [extensions/echo.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L100) Unix epoch seconds as a **string**, in the receiving user's local timezone ([utcunix](#utcunix) is UTC). *** ### utciso8601? > `optional` **utciso8601?**: `string` Defined in: [extensions/echo.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L94) ISO 8601 (UTC), e.g. `2024-01-15T08:30:00Z`. *** ### utcmw? > `optional` **utcmw?**: `string` Defined in: [extensions/echo.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L103) MediaWiki 14-digit timestamp. *** ### utcunix? > `optional` **utcunix?**: `number` Defined in: [extensions/echo.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L97) Unix epoch seconds as a number. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoTitle.md --- > 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: ApiEchoTitle Defined in: [extensions/echo.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L116) The title of the page a notification points at. ## Properties ### full? > `optional` **full?**: `string` Defined in: [extensions/echo.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L118) Full title with namespace prefix. *** ### namespace? > `optional` **namespace?**: `string` Defined in: [extensions/echo.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L121) Localized namespace prefix (`""` in the main namespace). *** ### namespace-key? > `optional` **namespace-key?**: `number` Defined in: [extensions/echo.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L124) Namespace index; hyphenated key, spelled literally. *** ### text? > `optional` **text?**: `string` Defined in: [extensions/echo.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L127) Title without the namespace prefix. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadPage.md --- > 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: ApiEchoUnreadPage Defined in: [extensions/echo.ts:287](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L287) Per-wiki unread summary keyed by page title. ## Properties ### count? > `optional` **count?**: `number` Defined in: [extensions/echo.ts:307](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L307) Unread notifications for this page. *** ### ns? > `optional` **ns?**: `number` Defined in: [extensions/echo.ts:295](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L295) Namespace index (only with `unpgrouppages`). *** ### pages? > `optional` **pages?**: (`string` | `null`)\[] Defined in: [extensions/echo.ts:304](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L304) Subject- and talk-page titles this count covers (only with `unpgrouppages`); contains `null` for the requesting user's own page. *** ### title? > `optional` **title?**: `string` | `null` Defined in: [extensions/echo.ts:292](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L292) Page title; `null` for the pseudo-row aggregating notifications not tied to any page (only appears with `unpgrouppages` off). *** ### unprefixed? > `optional` **unprefixed?**: `string` Defined in: [extensions/echo.ts:298](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L298) Title without the namespace prefix (only with `unpgrouppages`). --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadSource.md --- > 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: ApiEchoUnreadSource Defined in: [extensions/echo.ts:275](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L275) One wiki's unread-notification summary inside `unreadnotificationpages`. ## Properties ### base? > `optional` **base?**: `string` Defined in: [extensions/echo.ts:277](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L277) Article-path base of the source wiki. *** ### title? > `optional` **title?**: `string` Defined in: [extensions/echo.ts:283](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L283) Display name of the source wiki (localized project name, sitename fallback). *** ### url? > `optional` **url?**: `string` Defined in: [extensions/echo.ts:280](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L280) URL of the source wiki's `api.php` endpoint. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadWiki.md --- > 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: ApiEchoUnreadWiki Defined in: [extensions/echo.ts:311](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L311) One wiki's entry in `meta=unreadnotificationpages` (keyed by wiki id). ## Properties ### pages? > `optional` **pages?**: [`ApiEchoUnreadPage`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadPage.md)\[] Defined in: [extensions/echo.ts:316](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L316) Per-page unread counts. *** ### source? > `optional` **source?**: [`ApiEchoUnreadSource`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadSource.md) Defined in: [extensions/echo.ts:313](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L313) Where the notifications came from. *** ### totalCount? > `optional` **totalCount?**: `number` Defined in: [extensions/echo.ts:322](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L322) Total unread notifications on the wiki (badge-count semantics, capped at the notifications-badge limit); not the sum of [ApiEchoUnreadPage.count](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadPage.md#count). --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoArticleReminder.md --- > 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: ApiQueryEchoArticleReminder Defined in: [extensions/echo.ts:362](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L362) The `echoarticlereminder` object (returned under `query`). The module is only registered when `$wgAllowArticleReminderNotification` is on. ## Properties ### result? > `optional` **result?**: `"success"` Defined in: [extensions/echo.ts:364](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L364) Success sentinel; a rejected call comes back as a top-level error. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoMarkRead.md --- > 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: ApiQueryEchoMarkRead Defined in: [extensions/echo.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L47) The `echomarkread` object (returned under `query` by `action=echomarkread`). ## Properties ### alert > **alert**: [`ApiEchoNotificationCount`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationCount.md) Defined in: [extensions/echo.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L70) Remaining unread `alert`-section count. *** ### count > **count**: `string` Defined in: [extensions/echo.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L79) Overall remaining unread count, formatted. *** ### errors? > `optional` **errors?**: `object` Defined in: [extensions/echo.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L55) Per-wiki error from a failed foreign (cross-wiki) subrequest. #### Index Signature \[`wiki`: `string`]: `object` Error reported for the foreign wiki the key names. *** ### message > **message**: [`ApiEchoNotificationCount`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationCount.md) Defined in: [extensions/echo.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L73) Remaining unread `message`-section count. *** ### rawcount > **rawcount**: `number` Defined in: [extensions/echo.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L76) Overall remaining unread count. *** ### result > **result**: `"success"` Defined in: [extensions/echo.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L52) Success sentinel; a foreign wiki that fails is reported per wiki in [errors](#errors) instead of changing this value. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoMarkSeen.md --- > 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: ApiQueryEchoMarkSeen Defined in: [extensions/echo.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L83) The `echomarkseen` object (returned under `query` by `action=echomarkseen`). ## Properties ### result? > `optional` **result?**: `"success"` Defined in: [extensions/echo.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L85) Success sentinel; a rejected call comes back as a top-level error. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/echo.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L88) The "all notifications seen" timestamp just recorded. --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoNotifications.md --- > 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: ApiQueryEchoNotifications Defined in: [extensions/echo.ts:263](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L263) The `notifications` object (returned under `query` by `meta=notifications`). ## Extends - [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md) ## Properties ### alert? > `optional` **alert?**: [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md) Defined in: [extensions/echo.ts:268](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L268) Per-section results, present only with `notgroupbysection=1` — then [ApiEchoNotificationSection.list](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md#list) sits inside each section instead. *** ### continue? > `optional` **continue?**: `string` | `null` Defined in: [extensions/echo.ts:246](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L246) Continue cursor for this section, or `null` when the list is complete. #### Inherited from [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md).[`continue`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md#continue) *** ### count? > `optional` **count?**: `string` Defined in: [extensions/echo.ts:252](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L252) Unread count formatted for display. #### Inherited from [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md).[`count`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md#count) *** ### list? > `optional` **list?**: [`ApiEchoNotification`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotification.md)\[] Defined in: [extensions/echo.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L243) Notification rows. #### Inherited from [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md).[`list`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md#list) *** ### message? > `optional` **message?**: [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md) Defined in: [extensions/echo.ts:271](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L271) Message-section grouping; see [alert](#alert). *** ### rawcount? > `optional` **rawcount?**: `number` Defined in: [extensions/echo.ts:249](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L249) Raw numeric unread count. #### Inherited from [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md).[`rawcount`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md#rawcount) *** ### seenTime? > `optional` **seenTime?**: `string` | `Record`\<`string`, `string`> Defined in: [extensions/echo.ts:259](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L259) Last-seen timestamp. At the top level of `notifications` (flat mode) this is a map keyed by section name; inside a per-section object (grouped mode, `notgroupbysection=1`) it is a single ISO timestamp. #### Inherited from [`ApiEchoNotificationSection`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md).[`seenTime`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoNotificationSection.md#seentime) --- url: https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiQueryEchoUnreadPages.md --- > 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: ApiQueryEchoUnreadPages Defined in: [extensions/echo.ts:330](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/echo.ts#L330) The `unreadnotificationpages` object: a map from wiki id (e.g. `mediawikiwiki`) to that wiki's unread summary. A PHP map, so an empty result serializes as `[]`. ## Indexable > \[`wikiId`: `string`]: `unknown`\[] | [`ApiEchoUnreadWiki`](https://types-mediawiki-response.pages.dev/api/extensions/echo/ApiEchoUnreadWiki.md) | `undefined` Unread summary for the wiki the key names. --- url: https://types-mediawiki-response.pages.dev/api/extensions/extracts/overview.md --- > 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. # TextExtracts ## Type Aliases | Type Alias | Description | | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | [ApiExtract](https://types-mediawiki-response.pages.dev/api/extensions/extracts/ApiExtract.md) | A page content extract ([PlainText](https://types-mediawiki-response.pages.dev/api/core/PlainText.md) with `explaintext`, else HTML). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/extracts/ApiExtract.md --- > 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. # Type Alias: ApiExtract > **ApiExtract** = [`PlainText`](https://types-mediawiki-response.pages.dev/api/core/PlainText.md) Defined in: [extensions/extracts.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/extracts.ts#L20) A page content extract ([PlainText](https://types-mediawiki-response.pages.dev/api/core/PlainText.md) with `explaintext`, else HTML). --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/overview.md --- > 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. # FlaggedRevs ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [ApiConfiguredPage](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiConfiguredPage.md) | One row of `list=configuredpages` (pages with explicit stability configuration). | | [ApiFlagConfigEntry](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigEntry.md) | One quality setting reported by `action=flagconfig`. | | [ApiFlagConfigResponse](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigResponse.md) | Response of `action=flagconfig`. FlaggedRevs writes this at the **root** of the envelope (it is not a query module), so it sits beside `query`, not inside it. | | [ApiOldReviewedPage](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiOldReviewedPage.md) | One row of `list=oldreviewedpages` (stable versions that are out of date). | | [ApiPageFlagged](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiPageFlagged.md) | A page's FlaggedRevs state (`prop=flagged`). | | [ApiReviewResponse](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiReviewResponse.md) | Response of `action=review` (approve or unapprove a pending revision). | | [ApiRevisionFlagged](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiRevisionFlagged.md) | Review state attached to a single revision by `prop=revisions` (`rvprop=flagged`, injected by FlaggedRevs; requires `rvprop=ids` — the request fails with `missingparam` otherwise). | | [ApiStabilizeResponse](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiStabilizeResponse.md) | Response of `action=stabilize` (change a page's stable-version config). | | [ApiUnreviewedPage](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiUnreviewedPage.md) | One row of `list=unreviewedpages` (pages with a pending, unreviewed revision). | ## Type Aliases | Type Alias | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | [ApiQueryConfiguredPages](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryConfiguredPages.md) | `list=configuredpages` rows. | | [ApiQueryOldReviewedPages](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryOldReviewedPages.md) | `list=oldreviewedpages` rows. | | [ApiQueryUnreviewedPages](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryUnreviewedPages.md) | `list=unreviewedpages` rows. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiConfiguredPage.md --- > 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: ApiConfiguredPage Defined in: [extensions/flaggedrevs.ts:126](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L126) One row of `list=configuredpages` (pages with explicit stability configuration). ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### autoreview > **autoreview**: `string` Defined in: [extensions/flaggedrevs.ts:137](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L137) Autoreview right level (`fpc_level`), e.g. `sysop`; `""` when none. *** ### expiry > **expiry**: `string` Defined in: [extensions/flaggedrevs.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L140) Configured protection expiry, or `infinity`. *** ### last_revid > **last_revid**: `number` Defined in: [extensions/flaggedrevs.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L128) Id of the current (latest) revision. *** ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### stable_is_default > **stable_is_default**: `number` Defined in: [extensions/flaggedrevs.ts:134](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L134) Whether "stable" is the default view (`fpc_override`); `0`/`1` as an int. *** ### stable_revid > **stable_revid**: `number` Defined in: [extensions/flaggedrevs.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L131) Id of the stable revision. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigEntry.md --- > 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: ApiFlagConfigEntry Defined in: [extensions/flaggedrevs.ts:183](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L183) One quality setting reported by `action=flagconfig`. ## Properties ### levels > **levels**: `number` Defined in: [extensions/flaggedrevs.ts:188](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L188) Highest level available for this setting. *** ### name > **name**: `string` Defined in: [extensions/flaggedrevs.ts:185](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L185) Setting tag name, e.g. `quality`. *** ### tier1 > **tier1**: `number` Defined in: [extensions/flaggedrevs.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L191) Tier of the setting (`1` for the primary quality level). --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigResponse.md --- > 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: ApiFlagConfigResponse Defined in: [extensions/flaggedrevs.ts:198](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L198) Response of `action=flagconfig`. FlaggedRevs writes this at the **root** of the envelope (it is not a query module), so it sits beside `query`, not inside it. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### flagconfig? > `optional` **flagconfig?**: [`ApiFlagConfigEntry`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiFlagConfigEntry.md)\[] Defined in: [extensions/flaggedrevs.ts:204](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L204) Result of `action=flagconfig`. The list holds the single configured review tag (FlaggedRevs supports one quality dimension) and is empty in protection-only mode. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiOldReviewedPage.md --- > 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: ApiOldReviewedPage Defined in: [extensions/flaggedrevs.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L99) One row of `list=oldreviewedpages` (stable versions that are out of date). ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### diff_size > **diff_size**: `number` Defined in: [extensions/flaggedrevs.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L119) Bytes between the stable revision and the current one. *** ### flagged_level > **flagged_level**: `number` Defined in: [extensions/flaggedrevs.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L110) Quality level of the stable revision (`fp_quality`). *** ### flagged_level_text > **flagged_level_text**: `string` Defined in: [extensions/flaggedrevs.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L116) Localized level name. The module hard-codes `stable` here, so treat it as a label rather than a distinct level. *** ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### pending_since > **pending_since**: `string` Defined in: [extensions/flaggedrevs.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L107) When the pending revision appeared. *** ### revid > **revid**: `number` Defined in: [extensions/flaggedrevs.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L101) Id of the current (latest) revision. *** ### stable_revid > **stable_revid**: `number` Defined in: [extensions/flaggedrevs.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L104) Id of the current stable revision. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiPageFlagged.md --- > 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: ApiPageFlagged Defined in: [extensions/flaggedrevs.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L39) A page's FlaggedRevs state (`prop=flagged`). ## Properties ### level? > `optional` **level?**: `number` Defined in: [extensions/flaggedrevs.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L49) Review tier of the page's highest-quality reviewed revision (`fp_quality`). Only the checked tier (`0`) is emitted in 1.43; `1` (quality) and `2` (pristine) are historical values. Pages never reviewed carry no `flagged` object at all. *** ### level_text? > `optional` **level_text?**: `string` Defined in: [extensions/flaggedrevs.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L52) Display label for the stable revision; hard-coded to `stable`. *** ### pending_since? > `optional` **pending_since?**: `string` Defined in: [extensions/flaggedrevs.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L55) When a pending (unreviewed) revision appeared (`fp_pending_since`). *** ### protection_expiry? > `optional` **protection_expiry?**: `string` Defined in: [extensions/flaggedrevs.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L64) When that configured protection expires: ISO 8601 or the literal `infinity`. *** ### protection_level? > `optional` **protection_level?**: `string` Defined in: [extensions/flaggedrevs.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L61) Autoreview restriction level configured for the page (`fpc_level`), e.g. `sysop`; `""` when none. *** ### stable_revid? > `optional` **stable_revid?**: `number` Defined in: [extensions/flaggedrevs.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L41) Revision id of the current stable version (`fp_stable`). --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryConfiguredPages.md --- > 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. # Type Alias: ApiQueryConfiguredPages > **ApiQueryConfiguredPages** = [`ApiConfiguredPage`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiConfiguredPage.md)\[] Defined in: [extensions/flaggedrevs.ts:144](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L144) `list=configuredpages` rows. --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryOldReviewedPages.md --- > 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. # Type Alias: ApiQueryOldReviewedPages > **ApiQueryOldReviewedPages** = [`ApiOldReviewedPage`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiOldReviewedPage.md)\[] Defined in: [extensions/flaggedrevs.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L123) `list=oldreviewedpages` rows. --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiQueryUnreviewedPages.md --- > 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. # Type Alias: ApiQueryUnreviewedPages > **ApiQueryUnreviewedPages** = [`ApiUnreviewedPage`](https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiUnreviewedPage.md)\[] Defined in: [extensions/flaggedrevs.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L96) `list=unreviewedpages` rows. --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiReviewResponse.md --- > 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: ApiReviewResponse Defined in: [extensions/flaggedrevs.ts:147](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L147) Response of `action=review` (approve or unapprove a pending revision). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### review > **review**: `object` Defined in: [extensions/flaggedrevs.ts:149](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L149) Result of `action=review`. #### result > **result**: `"Success"` `Success` when the review was recorded; failures surface as API errors. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiRevisionFlagged.md --- > 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: ApiRevisionFlagged Defined in: [extensions/flaggedrevs.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L72) Review state attached to a single revision by `prop=revisions` (`rvprop=flagged`, injected by FlaggedRevs; requires `rvprop=ids` — the request fails with `missingparam` otherwise). ## Properties ### level? > `optional` **level?**: `number` Defined in: [extensions/flaggedrevs.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L80) Review tier; always `0` (checked) as of 1.43 — `1`/`2` are historical. *** ### level_text? > `optional` **level_text?**: `string` Defined in: [extensions/flaggedrevs.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L83) Display label for the tier; hard-coded to `stable`. *** ### tags? > `optional` **tags?**: `Record`\<`string`, `number`> Defined in: [extensions/flaggedrevs.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L86) Review-tag values, merged with the configured defaults (e.g. `accuracy`). *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/flaggedrevs.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L77) When the review was recorded. *** ### user? > `optional` **user?**: `string` Defined in: [extensions/flaggedrevs.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L74) Reviewer who approved the revision. --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiStabilizeResponse.md --- > 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: ApiStabilizeResponse Defined in: [extensions/flaggedrevs.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L162) Response of `action=stabilize` (change a page's stable-version config). Which variant serves the action depends on `$wgFlaggedRevsProtection`: the default mode returns `default`/`autoreview`, while the protection mode (`$wgFlaggedRevsProtection=true`) returns `protectlevel` instead. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### stabilize > **stabilize**: `object` Defined in: [extensions/flaggedrevs.ts:164](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L164) Result of `action=stabilize`; which keys appear depends on `$wgFlaggedRevsProtection`. #### autoreview? > `optional` **autoreview?**: `string` & `object` | `"sysop"` | `"none"` Which users' edits are auto-reviewed (default mode). #### default? > `optional` **default?**: `string` & `object` | `"latest"` | `"stable"` Which revision readers get by default (default mode). #### expiry > **expiry**: `string` When the configuration expires: ISO 8601 or the literal `infinity`. #### protectlevel? > `optional` **protectlevel?**: `string` & `object` | `"sysop"` | `"none"` Autoreview restriction applied (protection mode, `$wgFlaggedRevsProtection=true`). #### title > **title**: `string` Target page title. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/flaggedrevs/ApiUnreviewedPage.md --- > 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: ApiUnreviewedPage Defined in: [extensions/flaggedrevs.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L90) One row of `list=unreviewedpages` (pages with a pending, unreviewed revision). ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### revid > **revid**: `number` Defined in: [extensions/flaggedrevs.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/flaggedrevs.ts#L92) Id of the pending (latest) revision (`page_latest`). *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/extensions/gadgets/overview.md --- > 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. # Gadgets ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | [ApiGadget](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadget.md) | One gadget row (`list=gadgets`). | | [ApiGadgetCategory](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetCategory.md) | One gadget category (`list=gadgetcategories`, `gcprop`). | | [ApiGadgetMetadata](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetMetadata.md) | A gadget's `metadata` value (`gaprop=metadata`). | | [ApiGadgetModule](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetModule.md) | The `metadata.module` block: the ResourceLoader definition of the gadget. | | [ApiGadgetSettings](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetSettings.md) | The `metadata.settings` block of a gadget definition. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadget.md --- > 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: ApiGadget Defined in: [extensions/gadgets.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L148) One gadget row (`list=gadgets`). ## Properties ### desc? > `optional` **desc?**: `string` Defined in: [extensions/gadgets.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L156) Parsed HTML description. `gaprop=desc` (documented as potentially slow). *** ### id? > `optional` **id?**: `string` Defined in: [extensions/gadgets.ts:150](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L150) Internal gadget id, as written in `MediaWiki:Gadgets-definition`. `gaprop=id`. *** ### metadata? > `optional` **metadata?**: [`ApiGadgetMetadata`](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetMetadata.md) Defined in: [extensions/gadgets.ts:153](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L153) Definition metadata. `gaprop=metadata`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetCategory.md --- > 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: ApiGadgetCategory Defined in: [extensions/gadgets.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L160) One gadget category (`list=gadgetcategories`, `gcprop`). ## Properties ### desc? > `optional` **desc?**: `string` Defined in: [extensions/gadgets.ts:169](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L169) Parsed section description (`gadget-section-` message). Selected by `gcprop=title` but **keyed as `desc`**; omitted for the unnamed (default) category, which has no message to parse. *** ### members? > `optional` **members?**: `number` Defined in: [extensions/gadgets.ts:172](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L172) Number of gadgets in the category. `gcprop=members`. *** ### name? > `optional` **name?**: `string` Defined in: [extensions/gadgets.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L162) Internal category name as used in definitions. `gcprop=name`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetMetadata.md --- > 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: ApiGadgetMetadata Defined in: [extensions/gadgets.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L139) A gadget's `metadata` value (`gaprop=metadata`). ## Properties ### module > **module**: [`ApiGadgetModule`](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetModule.md) Defined in: [extensions/gadgets.ts:144](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L144) The ResourceLoader modules the gadget registers. *** ### settings > **settings**: [`ApiGadgetSettings`](https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetSettings.md) Defined in: [extensions/gadgets.ts:141](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L141) What the definition line encodes. --- url: https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetModule.md --- > 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: ApiGadgetModule Defined in: [extensions/gadgets.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L104) The `metadata.module` block: the ResourceLoader definition of the gadget. ## Properties ### codexIcons? > `optional` **codexIcons?**: `string`\[] Defined in: [extensions/gadgets.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L110) Codex icons the gadget needs. #### Since MediaWiki 1.45 *** ### datas > **datas**: `string`\[] Defined in: [extensions/gadgets.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L113) Names of `MediaWiki:Gadget-*.json` data pages. *** ### dependencies > **dependencies**: `string`\[] Defined in: [extensions/gadgets.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L116) ResourceLoader dependencies. *** ### messages > **messages**: `string`\[] Defined in: [extensions/gadgets.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L119) Message keys the gadget needs. *** ### peers > **peers**: `string`\[] Defined in: [extensions/gadgets.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L122) Gadgets that must be enabled together with this one. *** ### scripts > **scripts**: `string`\[] Defined in: [extensions/gadgets.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L125) Script module names. *** ### styles > **styles**: `string`\[] Defined in: [extensions/gadgets.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L128) Style module names. *** ### vues? > `optional` **vues?**: `string`\[] Defined in: [extensions/gadgets.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L135) Vue single-file components the gadget registers. #### Since MediaWiki 1.45 --- url: https://types-mediawiki-response.pages.dev/api/extensions/gadgets/ApiGadgetSettings.md --- > 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: ApiGadgetSettings Defined in: [extensions/gadgets.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L24) The `metadata.settings` block of a gadget definition. ## Properties ### actions > **actions**: `string`\[] Defined in: [extensions/gadgets.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L26) Interface actions the gadget needs, e.g. `edit`. *** ### categories? > `optional` **categories?**: `string`\[] Defined in: [extensions/gadgets.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L33) Categories the gadget needs the page to be in. #### Since MediaWiki 1.42 *** ### ~~category?~~ > `optional` **category?**: `string` Defined in: [extensions/gadgets.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L40) Definition category this gadget was declared under (`""` when none). #### Deprecated since MediaWiki 1.44; superseded by [categories](#categories). *** ### contentModels? > `optional` **contentModels?**: `string`\[] Defined in: [extensions/gadgets.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L47) Content models the gadget applies to. #### Since MediaWiki 1.41 *** ### default > **default**: `boolean` Defined in: [extensions/gadgets.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L50) Whether the gadget is on by default. *** ### hidden > **hidden**: `boolean` Defined in: [extensions/gadgets.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L53) Whether the gadget is hidden from the preferences list. *** ### ~~legacyscripts?~~ > `optional` **legacyscripts?**: `boolean` Defined in: [extensions/gadgets.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L60) Whether legacy (non-ResourceLoader) scripts are used. #### Deprecated since MediaWiki 1.47; the key is no longer emitted. *** ### namespaces? > `optional` **namespaces?**: `number`\[] Defined in: [extensions/gadgets.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L67) Namespace indexes the gadget applies to. #### Since MediaWiki 1.41 *** ### package > **package**: `boolean` Defined in: [extensions/gadgets.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L70) Whether the gadget is packaged with the extension. *** ### ~~requiresES6?~~ > `optional` **requiresES6?**: `boolean` Defined in: [extensions/gadgets.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L78) Whether the gadget requires ES6. #### Since MediaWiki 1.40 #### Deprecated since MediaWiki 1.47; the key is no longer emitted. *** ### rights > **rights**: `string`\[] Defined in: [extensions/gadgets.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L81) Rights the user must hold. *** ### section? > `optional` **section?**: `string` Defined in: [extensions/gadgets.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L88) Definition section this gadget was declared under (`""` when none). #### Since MediaWiki 1.44 *** ### shared > **shared**: `boolean` Defined in: [extensions/gadgets.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L94) Whether the gadget comes from a shared/common repo. The API module reports `false` for every gadget. *** ### skins > **skins**: `string`\[] Defined in: [extensions/gadgets.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L97) Skins the gadget applies to. *** ### supportsUrlLoad > **supportsUrlLoad**: `boolean` Defined in: [extensions/gadgets.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/gadgets.ts#L100) Whether the gadget can be loaded via `load.php` gadget URLs. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/overview.md --- > 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. # GlobalBlocking ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiGlobalBlock](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlock.md) | One global block record. `bgprop` controls which fields appear. From MediaWiki 1.43 the flag booleans below are real booleans (`false` included), emitted together with `bgprop=target` (also for the deprecated `bgprop=address`); earlier versions emit a flag only when the option applies, regardless of `bgprop`. | | [ApiGlobalBlockErrorResponse](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockErrorResponse.md) | Failure response of `action=globalblock`: the legacy `error.globalblock` array, written under the root `error` key rather than as a standard `ApiErrorResponse` — see [ApiGlobalBlockLegacyError](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md). | | [ApiGlobalBlockLegacyError](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md) | One entry of the legacy `error.globalblock` array that `action=globalblock` writes when a block or unblock fails. Unlike every other module, this one reports the failure **in-band** under the root `error` key (`{ error: { globalblock: [...] } }`) instead of a top-level error object, so that `error` carries no `code`/`info`. The shape is the same under every `errorformat`. | | [ApiGlobalBlockResponse](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResponse.md) | Response of `action=globalblock`. A failed block/unblock is reported in-band under the root `error` key; with `alsolocal=1`, a failed **local** block is reported the same way while the global block still succeeds, so both keys can appear together — see [ApiGlobalBlockLegacyError](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md). | | [ApiGlobalBlockResult](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResult.md) | Result object of `action=globalblock`. Which fields appear depends on the branch: blocking emits [ApiGlobalBlockResult.blocked](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResult.md#blocked) plus the applied options and [ApiGlobalBlockResult.expiry](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResult.md#expiry); unblocking emits [ApiGlobalBlockResult.unblocked](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResult.md#unblocked). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlock.md --- > 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: ApiGlobalBlock Defined in: [extensions/globalblocks.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L31) One global block record. `bgprop` controls which fields appear. From MediaWiki 1.43 the flag booleans below are real booleans (`false` included), emitted together with `bgprop=target` (also for the deprecated `bgprop=address`); earlier versions emit a flag only when the option applies, regardless of `bgprop`. ## Properties ### account-creation-disabled? > `optional` **account-creation-disabled?**: `boolean` Defined in: [extensions/globalblocks.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L82) Whether account creation is disabled by the block. A real `boolean`. #### Since MediaWiki 1.43 *** ### address? > `optional` **address?**: `string` Defined in: [extensions/globalblocks.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L39) Blocked user name / IP or range. `bgprop=address` — the deprecated spelling of `bgprop=target`. *** ### anononly? > `optional` **anononly?**: `boolean` Defined in: [extensions/globalblocks.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L75) Whether the block affects only anonymous users. A real `boolean`. *** ### autoblocking-enabled? > `optional` **autoblocking-enabled?**: `boolean` Defined in: [extensions/globalblocks.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L96) Whether autoblocking is enabled for the block. A real `boolean`. #### Since MediaWiki 1.43 *** ### automatic? > `optional` **automatic?**: `boolean` Defined in: [extensions/globalblocks.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L103) Whether this is an automatic (autoblock) block. A real `boolean`. #### Since MediaWiki 1.43 *** ### block-email? > `optional` **block-email?**: `boolean` Defined in: [extensions/globalblocks.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L89) Whether the block forbids sending email. A real `boolean`. #### Since MediaWiki 1.46 *** ### by? > `optional` **by?**: `string` Defined in: [extensions/globalblocks.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L48) Name of the global blocker. `bgprop=by`. *** ### bywiki? > `optional` **bywiki?**: `string` Defined in: [extensions/globalblocks.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L51) Wiki the blocking user acted from, e.g. `mediawikiwiki`. `bgprop=by`. *** ### expiry? > `optional` **expiry?**: `string` Defined in: [extensions/globalblocks.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L57) When the block expires, or `infinity`. `bgprop=expiry`. *** ### id? > `optional` **id?**: `string` Defined in: [extensions/globalblocks.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L33) Block id (a string under fv2). `bgprop=id`. *** ### rangeend? > `optional` **rangeend?**: `string` Defined in: [extensions/globalblocks.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L72) End of the blocked IP range. `bgprop=range`; absent for autoblocks, which hide their target. *** ### rangestart? > `optional` **rangestart?**: `string` Defined in: [extensions/globalblocks.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L66) Start of the blocked IP range. `bgprop=range`; absent for autoblocks, which hide their target. *** ### reason? > `optional` **reason?**: `string` Defined in: [extensions/globalblocks.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L60) Block reason. `bgprop=reason`. *** ### target? > `optional` **target?**: `string` Defined in: [extensions/globalblocks.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L45) Blocked user name / IP or range. `bgprop=target`; absent for autoblocks, which hide their target. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/globalblocks.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L54) When the block was applied. `bgprop=timestamp`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockErrorResponse.md --- > 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: ApiGlobalBlockErrorResponse Defined in: [extensions/globalblocks.ts:159](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L159) Failure response of `action=globalblock`: the legacy `error.globalblock` array, written under the root `error` key rather than as a standard `ApiErrorResponse` — see [ApiGlobalBlockLegacyError](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### error > **error**: `object` Defined in: [extensions/globalblocks.ts:161](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L161) The failures, one entry per message. #### globalblock > **globalblock**: [`ApiGlobalBlockLegacyError`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md)\[] *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md --- > 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: ApiGlobalBlockLegacyError Defined in: [extensions/globalblocks.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L146) One entry of the legacy `error.globalblock` array that `action=globalblock` writes when a block or unblock fails. Unlike every other module, this one reports the failure **in-band** under the root `error` key (`{ error: { globalblock: [...] } }`) instead of a top-level error object, so that `error` carries no `code`/`info`. The shape is the same under every `errorformat`. ## Properties ### code > **code**: `string` Defined in: [extensions/globalblocks.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L148) Machine-readable code, e.g. `globalblocking-notblocked`. *** ### message > **message**: `string` Defined in: [extensions/globalblocks.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L151) Rendered message text. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResponse.md --- > 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: ApiGlobalBlockResponse Defined in: [extensions/globalblocks.ts:172](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L172) Response of `action=globalblock`. A failed block/unblock is reported in-band under the root `error` key; with `alsolocal=1`, a failed **local** block is reported the same way while the global block still succeeds, so both keys can appear together — see [ApiGlobalBlockLegacyError](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### error? > `optional` **error?**: `object` Defined in: [extensions/globalblocks.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L177) Legacy errors, when the global block succeeded but the local one failed. #### globalblock > **globalblock**: [`ApiGlobalBlockLegacyError`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockLegacyError.md)\[] *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### globalblock > **globalblock**: [`ApiGlobalBlockResult`](https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResult.md) Defined in: [extensions/globalblocks.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L174) Result of `action=globalblock`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/ApiGlobalBlockResult.md --- > 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: ApiGlobalBlockResult Defined in: [extensions/globalblocks.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L112) Result object of `action=globalblock`. Which fields appear depends on the branch: blocking emits [ApiGlobalBlockResult.blocked](#blocked) plus the applied options and [ApiGlobalBlockResult.expiry](#expiry); unblocking emits [ApiGlobalBlockResult.unblocked](#unblocked). ## Properties ### allow-account-creation? > `optional` **allow-account-creation?**: `""` Defined in: [extensions/globalblocks.ts:126](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L126) Account creation is disabled by the block; an empty-string marker. *** ### anononly? > `optional` **anononly?**: `""` Defined in: [extensions/globalblocks.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L123) Only anonymous users are affected; an empty-string marker. *** ### blocked? > `optional` **blocked?**: `""` Defined in: [extensions/globalblocks.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L117) The block was applied; an empty-string marker. *** ### blockedlocally? > `optional` **blockedlocally?**: `true` Defined in: [extensions/globalblocks.ts:132](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L132) The target is also blocked locally on this wiki. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### enable-autoblock? > `optional` **enable-autoblock?**: `""` Defined in: [extensions/globalblocks.ts:129](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L129) Autoblocking is enabled for the block; an empty-string marker. *** ### expiry? > `optional` **expiry?**: `string` Defined in: [extensions/globalblocks.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L135) Block expiry, or `infinite`. *** ### unblocked? > `optional` **unblocked?**: `""` Defined in: [extensions/globalblocks.ts:120](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L120) The block was removed; an empty-string marker. *** ### user? > `optional` **user?**: `string` Defined in: [extensions/globalblocks.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalblocks.ts#L114) The blocked or unblocked user name, IP or range. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/overview.md --- > 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. # GlobalPreferences ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiGlobalPreferenceOverridesResponse](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverridesResponse.md) | Response of `action=globalpreferenceoverrides` — same reply style as [ApiGlobalPreferencesResponse](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResponse.md) for the local-override store. | | [ApiGlobalPreferencesResponse](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResponse.md) | Response of `action=globalpreferences` — the module key carries the plain string `"success"` (inherited from core `ApiOptions`), failures are top-level error responses. | | [ApiGlobalPreferencesResult](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResult.md) | The `globalpreferences` object of a `meta=globalpreferences` response. | ## Type Aliases | Type Alias | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | [ApiGlobalPreferenceOverrideValue](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverrideValue.md) | Value of a local override: the user's option value on this wiki, passed through as whatever scalar the option store holds. | | [ApiGlobalPreferenceValue](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceValue.md) | Value of a global preference: the stored value, returned verbatim (always a string). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverrideValue.md --- > 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. # Type Alias: ApiGlobalPreferenceOverrideValue > **ApiGlobalPreferenceOverrideValue** = `string` | `number` | `boolean` Defined in: [extensions/globalpreferences.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L34) Value of a local override: the user's option value on this wiki, passed through as whatever scalar the option store holds. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverridesResponse.md --- > 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: ApiGlobalPreferenceOverridesResponse Defined in: [extensions/globalpreferences.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L62) Response of `action=globalpreferenceoverrides` — same reply style as [ApiGlobalPreferencesResponse](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResponse.md) for the local-override store. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### globalpreferenceoverrides > **globalpreferenceoverrides**: `"success"` Defined in: [extensions/globalpreferences.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L64) Plain status string rather than a wrapper object; `success` on success. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceValue.md --- > 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. # Type Alias: ApiGlobalPreferenceValue > **ApiGlobalPreferenceValue** = `string` Defined in: [extensions/globalpreferences.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L28) Value of a global preference: the stored value, returned verbatim (always a string). --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResponse.md --- > 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: ApiGlobalPreferencesResponse Defined in: [extensions/globalpreferences.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L53) Response of `action=globalpreferences` — the module key carries the plain string `"success"` (inherited from core `ApiOptions`), failures are top-level error responses. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### globalpreferences > **globalpreferences**: `"success"` Defined in: [extensions/globalpreferences.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L55) Plain status string rather than a wrapper object; `success` on success. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferencesResult.md --- > 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: ApiGlobalPreferencesResult Defined in: [extensions/globalpreferences.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L37) The `globalpreferences` object of a `meta=globalpreferences` response. ## Properties ### localoverrides? > `optional` **localoverrides?**: `Record`\<`string`, [`ApiGlobalPreferenceOverrideValue`](https://types-mediawiki-response.pages.dev/api/extensions/globalpreferences/ApiGlobalPreferenceOverrideValue.md)> Defined in: [extensions/globalpreferences.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L45) Per-wiki overrides on top of the global values, keyed by preference name; `gprprop=localoverrides`. *** ### preferences? > `optional` **preferences?**: `Record`\<`string`, `string`> Defined in: [extensions/globalpreferences.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalpreferences.ts#L39) Global preference values keyed by preference name; `gprprop=preferences`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalusage/overview.md --- > 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. # GlobalUsage ## Interfaces | Interface | Description | | | | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ------ | ------ | | [ApiGlobalUsage](https://types-mediawiki-response.pages.dev/api/extensions/globalusage/ApiGlobalUsage.md) | One global-usage record. `guprop` is \`namespace | pageid | url\`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/globalusage/ApiGlobalUsage.md --- > 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: ApiGlobalUsage Defined in: [extensions/globalusage.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L17) One global-usage record. `guprop` is `namespace|pageid|url`. ## Properties ### ns? > `optional` **ns?**: `string` Defined in: [extensions/globalusage.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L28) Namespace index of the using page. `guprop=namespace`. Note: serialized as a **string** here (unlike the numeric `ns` elsewhere), like `pageid`. *** ### pageid? > `optional` **pageid?**: `string` Defined in: [extensions/globalusage.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L37) Page id on the remote wiki. `guprop=pageid`. Note: serialized as a **string** here (unlike the numeric `pageid` elsewhere). *** ### title > **title**: `string` Defined in: [extensions/globalusage.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L19) Title of the using page on the remote wiki (underscores, not spaces). *** ### url? > `optional` **url?**: `string` Defined in: [extensions/globalusage.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L31) Full URL of the using page. `guprop=url`. *** ### wiki > **wiki**: `string` Defined in: [extensions/globalusage.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globalusage.ts#L22) Domain of the wiki using the file, e.g. `www.mediawiki.org`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/overview.md --- > 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. # CentralAuth ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | [ApiGlobalUserInfo](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserInfo.md) | The `globaluserinfo` object of a `meta=globaluserinfo` response. | | [ApiGlobalUserLocalBlock](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserLocalBlock.md) | Local block details on an attached or unattached account entry. | | [ApiGlobalUserMerge](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserMerge.md) | One attached (merged) local account under `guiprop=merged`. | | [ApiGlobalUserUnattached](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserUnattached.md) | One unattached (not yet merged) local account under `guiprop=unattached`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserInfo.md --- > 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: ApiGlobalUserInfo Defined in: [extensions/globaluserinfo.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L79) The `globaluserinfo` object of a `meta=globaluserinfo` response. ## Properties ### editcount? > `optional` **editcount?**: `number` Defined in: [extensions/globaluserinfo.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L93) Aggregated edit count. `guiprop=editcount`. *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [extensions/globaluserinfo.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L96) Global groups. `guiprop=groups`. *** ### hidden? > `optional` **hidden?**: `true` Defined in: [extensions/globaluserinfo.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L111) Whether the account is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### home? > `optional` **home?**: `string` Defined in: [extensions/globaluserinfo.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L87) Wiki the account originated on, e.g. `mediawikiwiki`. *** ### id? > `optional` **id?**: `number` Defined in: [extensions/globaluserinfo.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L81) Global user id. *** ### locked? > `optional` **locked?**: `true` Defined in: [extensions/globaluserinfo.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L108) Whether the account is locked. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### merged? > `optional` **merged?**: [`ApiGlobalUserMerge`](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserMerge.md)\[] Defined in: [extensions/globaluserinfo.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L102) Per-wiki attached accounts. `guiprop=merged`. *** ### missing? > `optional` **missing?**: `true` Defined in: [extensions/globaluserinfo.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L117) Replaces the basic fields when the account does not exist (or is hidden from view). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). *** ### name? > `optional` **name?**: `string` Defined in: [extensions/globaluserinfo.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L84) Normalized user name. *** ### registration? > `optional` **registration?**: `string` Defined in: [extensions/globaluserinfo.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L90) Global registration timestamp. *** ### rights? > `optional` **rights?**: `string`\[] Defined in: [extensions/globaluserinfo.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L99) Global rights. `guiprop=rights`. *** ### unattached? > `optional` **unattached?**: [`ApiGlobalUserUnattached`](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserUnattached.md)\[] Defined in: [extensions/globaluserinfo.ts:105](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L105) Unattached local accounts. `guiprop=unattached`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserLocalBlock.md --- > 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: ApiGlobalUserLocalBlock Defined in: [extensions/globaluserinfo.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L22) Local block details on an attached or unattached account entry. ## Properties ### expiry? > `optional` **expiry?**: `string` Defined in: [extensions/globaluserinfo.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L24) Local block expiry, or `infinity`. *** ### reason? > `optional` **reason?**: `string` Defined in: [extensions/globaluserinfo.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L27) Local block reason. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserMerge.md --- > 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: ApiGlobalUserMerge Defined in: [extensions/globaluserinfo.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L31) One attached (merged) local account under `guiprop=merged`. ## Properties ### blocked? > `optional` **blocked?**: [`ApiGlobalUserLocalBlock`](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserLocalBlock.md) Defined in: [extensions/globaluserinfo.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L57) Local block, when the local account is blocked. *** ### editcount? > `optional` **editcount?**: `number` Defined in: [extensions/globaluserinfo.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L48) Local edit count. `guiprop=editcount`. *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [extensions/globaluserinfo.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L54) Local groups on that wiki. *** ### id? > `optional` **id?**: `number` Defined in: [extensions/globaluserinfo.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L39) Local user id on that wiki. *** ### method? > `optional` **method?**: `string` Defined in: [extensions/globaluserinfo.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L45) How the account was attached, e.g. `password`, `login`, `create`. *** ### registration? > `optional` **registration?**: `string` Defined in: [extensions/globaluserinfo.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L51) Local registration timestamp. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [extensions/globaluserinfo.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L42) When the local account was attached. *** ### url? > `optional` **url?**: `string` Defined in: [extensions/globaluserinfo.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L36) Base URL of the wiki. *** ### wiki? > `optional` **wiki?**: `string` Defined in: [extensions/globaluserinfo.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L33) Wiki id, e.g. `mediawikiwiki`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserUnattached.md --- > 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: ApiGlobalUserUnattached Defined in: [extensions/globaluserinfo.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L61) One unattached (not yet merged) local account under `guiprop=unattached`. ## Properties ### blocked? > `optional` **blocked?**: [`ApiGlobalUserLocalBlock`](https://types-mediawiki-response.pages.dev/api/extensions/globaluserinfo/ApiGlobalUserLocalBlock.md) Defined in: [extensions/globaluserinfo.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L75) Local block, when the local account is blocked. *** ### editcount? > `optional` **editcount?**: `number` Defined in: [extensions/globaluserinfo.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L66) Local edit count. *** ### groups? > `optional` **groups?**: `string`\[] Defined in: [extensions/globaluserinfo.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L72) Local groups on that wiki. *** ### registration? > `optional` **registration?**: `string` Defined in: [extensions/globaluserinfo.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L69) Local registration timestamp. *** ### wiki? > `optional` **wiki?**: `string` Defined in: [extensions/globaluserinfo.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/globaluserinfo.ts#L63) Wiki id, e.g. `mediawikiwiki`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/linter/overview.md --- > 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. # Linter ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | [ApiLinterGeneralInfo](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLinterGeneralInfo.md) | Lint-error category priorities injected into `siprop=general`. | | [ApiLintError](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintError.md) | One lint error (`list=linterrors`). | | [ApiLintErrorParams](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintErrorParams.md) | Extra parameters carried by a lint error (template name, tag, …). | | [ApiLintTemplateInfo](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintTemplateInfo.md) | Template context for an error that sits inside a transclusion. | | [ApiQueryLinterStats](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiQueryLinterStats.md) | The `linterstats` object (returned under `query` by `meta=linterstats`). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintError.md --- > 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: ApiLintError Defined in: [extensions/linter.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L45) One lint error (`list=linterrors`). ## Extends - [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md) ## Properties ### category > **category**: `string` Defined in: [extensions/linter.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L50) Error category key, e.g. `missing-end-tag`. Open union. *** ### lintId > **lintId**: `number` Defined in: [extensions/linter.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L47) Lint row id; feed it back as `lntfrom` to continue, or to the edit form. *** ### location > **location**: `number`\[] Defined in: [extensions/linter.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L53) `[start, end]` byte offsets of the offending markup in the parsable source. *** ### ns > **ns**: `number` Defined in: [core/query/shared.ts:12](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L12) Namespace index. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`ns`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#ns) *** ### pageid > **pageid**: `number` Defined in: [core/query/shared.ts:9](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L9) Page id. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`pageid`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#pageid) *** ### params > **params**: [`ApiLintErrorParams`](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintErrorParams.md) Defined in: [extensions/linter.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L59) Error-specific extras. Forced to a map, so an empty value is `{}`. *** ### templateInfo > **templateInfo**: [`ApiLintTemplateInfo`](https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintTemplateInfo.md) Defined in: [extensions/linter.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L56) Template context; `{}` when the error does not sit inside a transclusion. *** ### title > **title**: `string` Defined in: [core/query/shared.ts:15](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L15) Full page title. #### Inherited from [`ApiPageRef`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md).[`title`](https://types-mediawiki-response.pages.dev/api/core/ApiPageRef.md#title) --- url: https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintErrorParams.md --- > 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: ApiLintErrorParams Defined in: [extensions/linter.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L36) Extra parameters carried by a lint error (template name, tag, …). ## Indexable > \[`key`: `string`]: `unknown` Any other parameter the error's category attaches. ## Properties ### name? > `optional` **name?**: `string` Defined in: [extensions/linter.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L38) Name of the offending tag or template. --- url: https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLintTemplateInfo.md --- > 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: ApiLintTemplateInfo Defined in: [extensions/linter.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L27) Template context for an error that sits inside a transclusion. ## Properties ### multiPartTemplateBlock? > `optional` **multiPartTemplateBlock?**: `boolean` Defined in: [extensions/linter.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L32) Whether the error spans a multi-part template block. *** ### title? > `optional` **title?**: `string` Defined in: [extensions/linter.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L29) Full template title, e.g. `Template:Foo`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiLinterGeneralInfo.md --- > 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: ApiLinterGeneralInfo Defined in: [extensions/linter.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L72) Lint-error category priorities injected into `siprop=general`. ## Properties ### high > **high**: `string`\[] Defined in: [extensions/linter.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L74) High-priority categories. *** ### low > **low**: `string`\[] Defined in: [extensions/linter.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L80) Low-priority categories. *** ### medium > **medium**: `string`\[] Defined in: [extensions/linter.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L77) Medium-priority categories. --- url: https://types-mediawiki-response.pages.dev/api/extensions/linter/ApiQueryLinterStats.md --- > 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: ApiQueryLinterStats Defined in: [extensions/linter.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L63) The `linterstats` object (returned under `query` by `meta=linterstats`). ## Properties ### totals? > `optional` **totals?**: `Record`\<`string`, `number`> Defined in: [extensions/linter.ts:68](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/linter.ts#L68) Per-category totals, keyed by error category (e.g. `missing-end-tag`). Keys are site-configurable. --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/overview.md --- > 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. # MassMessage ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [ApiEditMassMessageListResponse](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResponse.md) | Response of `action=editmassmessagelist`. | | [ApiEditMassMessageListResult](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResult.md) | The `editmassmessagelist` object of an `action=editmassmessagelist` response. | | [ApiMassMessageInvalidTarget](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageInvalidTarget.md) | One invalid target of `invalidadd`: the submitted string under `*` plus an empty-string entry per error code (e.g. `invalidsite`, `invalidtitle`). `invalidremove` reports plain strings and an unchanged description comes back as a plain string under `invaliddescription`. | | [ApiMassMessageResponse](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResponse.md) | Response of `action=massmessage` (requires the `massmessage` right). | | [ApiMassMessageResult](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResult.md) | The `massmessage` object of an `action=massmessage` response. | | [ApiMassMessageTarget](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageTarget.md) | One valid target echoed back by `action=editmassmessagelist`. | | [ApiMmContent](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMmContent.md) | The `mmcontent` object of a `prop=mmcontent` response. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResponse.md --- > 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: ApiEditMassMessageListResponse Defined in: [extensions/massmessage.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L97) Response of `action=editmassmessagelist`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### editmassmessagelist > **editmassmessagelist**: [`ApiEditMassMessageListResult`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResult.md) Defined in: [extensions/massmessage.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L99) Result of `action=editmassmessagelist`. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiEditMassMessageListResult.md --- > 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: ApiEditMassMessageListResult Defined in: [extensions/massmessage.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L70) The `editmassmessagelist` object of an `action=editmassmessagelist` response. ## Properties ### added? > `optional` **added?**: [`ApiMassMessageTarget`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageTarget.md)\[] Defined in: [extensions/massmessage.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L78) Targets actually added (deduplicated, canonicalized). *** ### description? > `optional` **description?**: `string` Defined in: [extensions/massmessage.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L90) The new description, when it changed. *** ### invalidadd? > `optional` **invalidadd?**: [`ApiMassMessageInvalidTarget`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageInvalidTarget.md)\[] Defined in: [extensions/massmessage.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L84) Submitted targets that could not be parsed or did not match a list entry. *** ### invaliddescription? > `optional` **invaliddescription?**: `string` Defined in: [extensions/massmessage.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L93) The submitted description when it was identical to the current one. *** ### invalidremove? > `optional` **invalidremove?**: `string`\[] Defined in: [extensions/massmessage.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L87) Submitted `remove` strings that were not valid list targets. *** ### removed? > `optional` **removed?**: [`ApiMassMessageTarget`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageTarget.md)\[] Defined in: [extensions/massmessage.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L81) Targets removed. *** ### result > **result**: `"Success"` | `"Done"` Defined in: [extensions/massmessage.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L75) `Success` when everything applied; `Done` when any submitted target was invalid (see [invalidadd](#invalidadd) / [invalidremove](#invalidremove)). --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageInvalidTarget.md --- > 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: ApiMassMessageInvalidTarget Defined in: [extensions/massmessage.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L61) One invalid target of `invalidadd`: the submitted string under `*` plus an empty-string entry per error code (e.g. `invalidsite`, `invalidtitle`). `invalidremove` reports plain strings and an unchanged description comes back as a plain string under `invaliddescription`. ## Indexable > \[`error`: `string`]: `string` Error codes are added as empty-string keys (e.g. `invalidsite`). ## Properties ### \* > **\***: `string` Defined in: [extensions/massmessage.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L63) The submitted target string. --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResponse.md --- > 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: ApiMassMessageResponse Defined in: [extensions/massmessage.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L112) Response of `action=massmessage` (requires the `massmessage` right). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### massmessage > **massmessage**: [`ApiMassMessageResult`](https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResult.md) Defined in: [extensions/massmessage.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L114) Result of `action=massmessage`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageResult.md --- > 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: ApiMassMessageResult Defined in: [extensions/massmessage.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L103) The `massmessage` object of an `action=massmessage` response. ## Properties ### count > **count**: `number` Defined in: [extensions/massmessage.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L108) Number of targets the message was queued for. *** ### result > **result**: `"success"` Defined in: [extensions/massmessage.ts:105](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L105) `success` (lowercase) when delivery was queued. --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMassMessageTarget.md --- > 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: ApiMassMessageTarget Defined in: [extensions/massmessage.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L44) One valid target echoed back by `action=editmassmessagelist`. ## Properties ### missing? > `optional` **missing?**: `string` Defined in: [extensions/massmessage.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L52) Empty-string marker for local targets whose page does not exist (fv2 quirk). *** ### site? > `optional` **site?**: `string` Defined in: [extensions/massmessage.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L49) Domain of the target wiki, e.g. `www.mediawiki.org`; absent for local targets. *** ### title? > `optional` **title?**: `string` Defined in: [extensions/massmessage.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L46) Canonical page title of the target. --- url: https://types-mediawiki-response.pages.dev/api/extensions/massmessage/ApiMmContent.md --- > 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: ApiMmContent Defined in: [extensions/massmessage.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L29) The `mmcontent` object of a `prop=mmcontent` response. ## Properties ### description > **description**: `string` | `null` Defined in: [extensions/massmessage.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L34) Delivery list description as stored; the query module returns it verbatim, so it is `null` when the list carries none. *** ### targets > **targets**: `string`\[] Defined in: [extensions/massmessage.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/massmessage.ts#L40) Targets as user-facing strings — page titles, and `title@site` for cross-wiki targets (only when `$wgAllowGlobalMessaging` allows them). --- url: https://types-mediawiki-response.pages.dev/api/extensions/oathauth/overview.md --- > 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. # OATHAuth ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [~~ApiOATHStatus~~](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHStatus.md) | The `oath` object of a `meta=oath` response. | | [ApiOATHValidateResponse](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidateResponse.md) | Response of `action=oathvalidate`. | | [~~ApiOATHValidation~~](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidation.md) | The `oathvalidate` object of an `action=oathvalidate` response. | | [ApiWebAuthnResponse](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResponse.md) | Response of `action=webauthn`, introduced by the 1.46 WebAuthn rewrite that replaced `meta=oath`/`action=oathvalidate`. | | [ApiWebAuthnResult](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResult.md) | The `webauthn` object of an `action=webauthn` response, keyed by the `func` parameter: `getauthinfo` → [ApiWebAuthnResult.auth_info](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResult.md#auth_info), `getregisterinfo` → [ApiWebAuthnResult.register_info](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResult.md#register_info), `register` → [ApiWebAuthnResult.success](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResult.md#success). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHStatus.md --- > 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: ApiOATHStatus~~ Defined in: [extensions/oathauth.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L37) The `oath` object of a `meta=oath` response. ## Deprecated since MediaWiki 1.46; OATHAuth dropped the `meta=oath` module in its 1.46 (WebAuthn) rewrite. The TOTP data it reported has no direct replacement in the new API. ## Properties ### ~~enabled?~~ > `optional` **enabled?**: `boolean` Defined in: [extensions/oathauth.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L42) Whether the queried user (defaults to the current user) has two-factor authentication enabled. --- url: https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidateResponse.md --- > 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: ApiOATHValidateResponse Defined in: [extensions/oathauth.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L60) Response of `action=oathvalidate`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### oathvalidate > **oathvalidate**: [`ApiOATHValidation`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidation.md) Defined in: [extensions/oathauth.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L62) Result of `action=oathvalidate`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiOATHValidation.md --- > 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: ApiOATHValidation~~ Defined in: [extensions/oathauth.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L51) The `oathvalidate` object of an `action=oathvalidate` response. ## Deprecated since MediaWiki 1.46; OATHAuth removed the `action=oathvalidate` module in its 1.46 (WebAuthn) rewrite. ## Properties ### ~~enabled?~~ > `optional` **enabled?**: `boolean` Defined in: [extensions/oathauth.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L53) Whether the target user has 2FA enabled (only then is a token verifiable). *** ### ~~valid?~~ > `optional` **valid?**: `boolean` Defined in: [extensions/oathauth.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L56) Whether the supplied TOTP or recovery code verified successfully. --- url: https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResponse.md --- > 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: ApiWebAuthnResponse Defined in: [extensions/oathauth.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L88) Response of `action=webauthn`, introduced by the 1.46 WebAuthn rewrite that replaced `meta=oath`/`action=oathvalidate`. ## Since MediaWiki 1.46 ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) *** ### webauthn? > `optional` **webauthn?**: [`ApiWebAuthnResult`](https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResult.md) Defined in: [extensions/oathauth.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L90) Result of `action=webauthn`; which field carries the payload depends on `func`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/oathauth/ApiWebAuthnResult.md --- > 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: ApiWebAuthnResult Defined in: [extensions/oathauth.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L71) The `webauthn` object of an `action=webauthn` response, keyed by the `func` parameter: `getauthinfo` → [ApiWebAuthnResult.auth_info](#auth_info), `getregisterinfo` → [ApiWebAuthnResult.register_info](#register_info), `register` → [ApiWebAuthnResult.success](#success). ## Properties ### auth_info? > `optional` **auth_info?**: `string` Defined in: [extensions/oathauth.ts:73](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L73) WebAuthn authentication challenge as a JSON string (`func=getauthinfo`). *** ### register_info? > `optional` **register_info?**: `string` Defined in: [extensions/oathauth.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L76) WebAuthn registration challenge as a JSON string (`func=getregisterinfo`). *** ### success? > `optional` **success?**: `true` Defined in: [extensions/oathauth.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/oathauth.ts#L79) The credential was registered (`func=register`). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). --- url: https://types-mediawiki-response.pages.dev/api/extensions/pageimages/overview.md --- > 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. # PageImages ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------- | | [ApiThumbnail](https://types-mediawiki-response.pages.dev/api/extensions/pageimages/ApiThumbnail.md) | A scaled image reference (`piprop=thumbnail`). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/pageimages/ApiThumbnail.md --- > 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: ApiThumbnail Defined in: [extensions/pageimages.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L20) A scaled image reference (`piprop=thumbnail`). ## Properties ### height > **height**: `number` Defined in: [extensions/pageimages.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L28) Rendered height in pixels. *** ### source > **source**: `string` Defined in: [extensions/pageimages.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L22) Image URL. *** ### width > **width**: `number` Defined in: [extensions/pageimages.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageimages.ts#L25) Rendered width in pixels. --- url: https://types-mediawiki-response.pages.dev/api/extensions/pageviews/overview.md --- > 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. # PageViewInfo ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | | [ApiMostViewedPage](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiMostViewedPage.md) | One row of `list=mostviewed`. | | [ApiPageViewServiceMetrics](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiPageViewServiceMetrics.md) | Per-service metric support injected into `siprop=general`. | ## Type Aliases | Type Alias | Description | | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | [ApiViewCounts](https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiViewCounts.md) | Date-keyed (`YYYY-MM-DD`) view counts; the newest, incomplete day may be `null`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiMostViewedPage.md --- > 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: ApiMostViewedPage Defined in: [extensions/pageviews.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L31) One row of `list=mostviewed`. ## Properties ### count > **count**: `number` Defined in: [extensions/pageviews.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L39) View count over the reported window. *** ### ns > **ns**: `number` Defined in: [extensions/pageviews.ts:33](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L33) Namespace index (rows may include pseudo-namespaces, e.g. `-1` for `Special:`). *** ### title > **title**: `string` Defined in: [extensions/pageviews.ts:36](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L36) Page title, prefixed for non-main namespaces. --- url: https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiPageViewServiceMetrics.md --- > 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: ApiPageViewServiceMetrics Defined in: [extensions/pageviews.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L43) Per-service metric support injected into `siprop=general`. ## Properties ### pageviews > **pageviews**: `boolean` Defined in: [extensions/pageviews.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L45) Whether the service can serve per-page view counts. *** ### uniques > **uniques**: `boolean` Defined in: [extensions/pageviews.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L48) Whether the service can serve unique-visitor counts. --- url: https://types-mediawiki-response.pages.dev/api/extensions/pageviews/ApiViewCounts.md --- > 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. # Type Alias: ApiViewCounts > **ApiViewCounts** = `Record`\<`string`, `number` | `null`> Defined in: [extensions/pageviews.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/pageviews.ts#L28) Date-keyed (`YYYY-MM-DD`) view counts; the newest, incomplete day may be `null`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/overview.md --- > 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. # ReadingLists ## Interfaces | Interface | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | [ApiReadingListEntry](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListEntry.md) | One page saved in a reading list (`list=readinglistentries`, and the `entry`/`entries` payload of the `createentry` command). | | [ApiReadingListItem](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md) | One reading list (`meta=readinglists`, and the `list`/`lists` payload of the `create` / `update` / `setup` commands). | | [ApiReadingListsCreateEntryResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateEntryResponse.md) | Response of `action=readinglists&command=createentry`. A single `project` + `title` returns `id` + `entry`; a `batch` returns `ids` + `entries`. | | [ApiReadingListsCreateResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateResponse.md) | Response of `action=readinglists&command=create`. A single `name` returns `id` + `list`; a `batch` returns `ids` + `lists`. | | [ApiReadingListsDeleteEntryResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteEntryResponse.md) | Response of `action=readinglists&command=deleteentry` (single `entry` or `batch`). | | [ApiReadingListsDeleteResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteResponse.md) | Response of `action=readinglists&command=delete` (single `list` or `batch`). | | [ApiReadingListsSetupResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsSetupResponse.md) | Response of `action=readinglists&command=setup` (no arguments). | | [ApiReadingListsTeardownResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsTeardownResponse.md) | Response of `action=readinglists&command=teardown` (no arguments). | | [ApiReadingListsUpdateResponse](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsUpdateResponse.md) | Response of `action=readinglists&command=update`. A single `list` returns `id` + `list`; a `batch` returns `ids` + `lists`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListEntry.md --- > 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: ApiReadingListEntry Defined in: [extensions/readinglists.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L84) One page saved in a reading list (`list=readinglistentries`, and the `entry`/`entries` payload of the `createentry` command). ## Properties ### created > **created**: `string` Defined in: [extensions/readinglists.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L102) Creation time (ISO 8601). *** ### deleted? > `optional` **deleted?**: `true` Defined in: [extensions/readinglists.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L111) `true` for an entry soft-deleted within the retention window; changes mode only. *** ### duplicate? > `optional` **duplicate?**: `boolean` Defined in: [extensions/readinglists.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L108) Merge-detection flag of the `createentry` command; absent on plain reads. *** ### id > **id**: `number` Defined in: [extensions/readinglists.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L86) Entry id. *** ### listId > **listId**: `number` Defined in: [extensions/readinglists.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L89) Id of the list this entry belongs to. *** ### project > **project**: `string` Defined in: [extensions/readinglists.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L96) Canonical base URL of the wiki the entry points to (port omitted, e.g. `https://www.mediawiki.org`). Entries are cross-wiki; the `@local` project value resolves to the serving wiki's own URL here. *** ### title > **title**: `string` Defined in: [extensions/readinglists.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L99) Page title on [project](#project). *** ### updated > **updated**: `string` Defined in: [extensions/readinglists.ts:105](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L105) Last update time (ISO 8601). --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md --- > 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: ApiReadingListItem Defined in: [extensions/readinglists.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L47) One reading list (`meta=readinglists`, and the `list`/`lists` payload of the `create` / `update` / `setup` commands). ## Properties ### created > **created**: `string` Defined in: [extensions/readinglists.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L61) Creation time (ISO 8601). *** ### default > **default**: `boolean` Defined in: [extensions/readinglists.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L55) Whether this is the user's catch-all default list. *** ### deleted? > `optional` **deleted?**: `true` Defined in: [extensions/readinglists.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L77) `true` for a list soft-deleted within the retention window; appears only in `changedsince` mode, where the list is reported under a `deleted-` `name`. *** ### description > **description**: `string` Defined in: [extensions/readinglists.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L58) Free-text description; `""` when none was set. *** ### duplicate? > `optional` **duplicate?**: `boolean` Defined in: [extensions/readinglists.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L70) Whether a list with the same name already existed, carried by the `create` command; absent on plain reads. *** ### id > **id**: `number` Defined in: [extensions/readinglists.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L49) List id. *** ### name > **name**: `string` Defined in: [extensions/readinglists.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L52) List title as set by the owner. *** ### updated > **updated**: `string` Defined in: [extensions/readinglists.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L64) Last update time (ISO 8601). --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateEntryResponse.md --- > 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: ApiReadingListsCreateEntryResponse Defined in: [extensions/readinglists.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L187) Response of `action=readinglists&command=createentry`. A single `project` + `title` returns `id` + `entry`; a `batch` returns `ids` + `entries`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### createentry > **createentry**: `object` Defined in: [extensions/readinglists.ts:189](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L189) Result of the `createentry` command. #### entries? > `optional` **entries?**: [`ApiReadingListEntry`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListEntry.md)\[] New entries for a batch create. #### entry? > `optional` **entry?**: [`ApiReadingListEntry`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListEntry.md) New entry for a single create. #### id? > `optional` **id?**: `string` New entry id (raw database value) for a single create. #### ids? > `optional` **ids?**: `string`\[] New entry ids for a batch create. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsCreateResponse.md --- > 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: ApiReadingListsCreateResponse Defined in: [extensions/readinglists.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L130) Response of `action=readinglists&command=create`. A single `name` returns `id` + `list`; a `batch` returns `ids` + `lists`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### create > **create**: `object` Defined in: [extensions/readinglists.ts:132](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L132) Result of the `create` command. #### id? > `optional` **id?**: `string` New list id (raw database value) for a single create. #### ids? > `optional` **ids?**: `string`\[] New list ids for a batch create. #### list? > `optional` **list?**: [`ApiReadingListItem`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md) New list for a single create. #### lists? > `optional` **lists?**: [`ApiReadingListItem`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md)\[] New lists for a batch create. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteEntryResponse.md --- > 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: ApiReadingListsDeleteEntryResponse Defined in: [extensions/readinglists.ts:211](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L211) Response of `action=readinglists&command=deleteentry` (single `entry` or `batch`). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### deleteentry > **deleteentry**: `object` Defined in: [extensions/readinglists.ts:213](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L213) Result of the `deleteentry` command — a bare success sentinel. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsDeleteResponse.md --- > 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: ApiReadingListsDeleteResponse Defined in: [extensions/readinglists.ts:175](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L175) Response of `action=readinglists&command=delete` (single `list` or `batch`). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### delete > **delete**: `object` Defined in: [extensions/readinglists.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L177) Result of the `delete` command — a bare success sentinel. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsSetupResponse.md --- > 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: ApiReadingListsSetupResponse Defined in: [extensions/readinglists.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L115) Response of `action=readinglists&command=setup` (no arguments). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### setup > **setup**: `object` Defined in: [extensions/readinglists.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L117) Result of the `setup` command. #### list > **list**: [`ApiReadingListItem`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md) The user's default list, created for them. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsTeardownResponse.md --- > 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: ApiReadingListsTeardownResponse Defined in: [extensions/readinglists.ts:220](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L220) Response of `action=readinglists&command=teardown` (no arguments). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### teardown > **teardown**: `object` Defined in: [extensions/readinglists.ts:222](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L222) Result of the `teardown` command — a bare success sentinel. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListsUpdateResponse.md --- > 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: ApiReadingListsUpdateResponse Defined in: [extensions/readinglists.ts:154](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L154) Response of `action=readinglists&command=update`. A single `list` returns `id` + `list`; a `batch` returns `ids` + `lists`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### update > **update**: `object` Defined in: [extensions/readinglists.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/readinglists.ts#L156) Result of the `update` command. #### id? > `optional` **id?**: `string` Updated list id (raw database value) for a single update. #### ids? > `optional` **ids?**: `string`\[] Updated list ids for a batch update. #### list? > `optional` **list?**: [`ApiReadingListItem`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md) Updated list for a single update. #### lists? > `optional` **lists?**: [`ApiReadingListItem`](https://types-mediawiki-response.pages.dev/api/extensions/readinglists/ApiReadingListItem.md)\[] Updated lists for a batch update. #### result > **result**: `"Success"` Always `Success` on the success branch; failures are top-level errors. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/scribunto/overview.md --- > 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. # Scribunto ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | [ApiScribuntoConsoleError](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleError.md) | The `type: "error"` shape (a Lua error reported in band). | | [ApiScribuntoConsoleNormal](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleNormal.md) | The `type: "normal"` shape (`print` output plus the returned value). | ## Type Aliases | Type Alias | Description | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiScribuntoConsoleResponse](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleResponse.md) | Response of `action=scribunto-console`. Discriminated on type: a [ApiScribuntoConsoleNormal](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleNormal.md) result or an [ApiScribuntoConsoleError](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleError.md) one, both merged onto the envelope at the root. | | [ScribuntoConsoleType](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ScribuntoConsoleType.md) | Console outcome. Scribunto reports `normal` / `error` in band; open for future kinds. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleError.md --- > 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: ApiScribuntoConsoleError Defined in: [extensions/scribunto.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L56) The `type: "error"` shape (a Lua error reported in band). ## Extends - `ApiScribuntoConsoleBase` ## Properties ### html? > `optional` **html?**: `string` Defined in: [extensions/scribunto.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L58) Rendered error plus backtrace HTML (`
    …`). *** ### message? > `optional` **message?**: `string` Defined in: [extensions/scribunto.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L61) Plain-text error message. *** ### messagename? > `optional` **messagename?**: `string` Defined in: [extensions/scribunto.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L64) i18n key of [message](#message). *** ### session? > `optional` **session?**: `number` Defined in: [extensions/scribunto.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L34) Opaque console session id; echo it back (via a stable cookie) to keep state across questions. #### Inherited from `ApiScribuntoConsoleBase.session` *** ### sessionIsNew? > `optional` **sessionIsNew?**: `""` Defined in: [extensions/scribunto.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L43) Valueless flag: the empty string when this question started a new session, else absent. #### Inherited from `ApiScribuntoConsoleBase.sessionIsNew` *** ### sessionMaxSize? > `optional` **sessionMaxSize?**: `number` Defined in: [extensions/scribunto.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L40) Byte ceiling before `scribunto-console-too-large` is raised. #### Inherited from `ApiScribuntoConsoleBase.sessionMaxSize` *** ### sessionSize? > `optional` **sessionSize?**: `number` Defined in: [extensions/scribunto.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L37) Bytes used so far in the session (content plus accumulated questions). #### Inherited from `ApiScribuntoConsoleBase.sessionSize` *** ### type? > `optional` **type?**: [`ScribuntoConsoleType`](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ScribuntoConsoleType.md) Defined in: [extensions/scribunto.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L31) Whether the question evaluated cleanly (`normal`) or raised a Lua error (`error`). #### Inherited from `ApiScribuntoConsoleBase.type` --- url: https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleNormal.md --- > 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: ApiScribuntoConsoleNormal Defined in: [extensions/scribunto.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L47) The `type: "normal"` shape (`print` output plus the returned value). ## Extends - `ApiScribuntoConsoleBase` ## Properties ### print? > `optional` **print?**: `string` Defined in: [extensions/scribunto.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L49) Text emitted by `print()` calls (newline-terminated); empty when nothing printed. *** ### return? > `optional` **return?**: `string` Defined in: [extensions/scribunto.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L52) Stringified value from a `return` statement; empty when the question returned nothing. *** ### session? > `optional` **session?**: `number` Defined in: [extensions/scribunto.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L34) Opaque console session id; echo it back (via a stable cookie) to keep state across questions. #### Inherited from `ApiScribuntoConsoleBase.session` *** ### sessionIsNew? > `optional` **sessionIsNew?**: `""` Defined in: [extensions/scribunto.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L43) Valueless flag: the empty string when this question started a new session, else absent. #### Inherited from `ApiScribuntoConsoleBase.sessionIsNew` *** ### sessionMaxSize? > `optional` **sessionMaxSize?**: `number` Defined in: [extensions/scribunto.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L40) Byte ceiling before `scribunto-console-too-large` is raised. #### Inherited from `ApiScribuntoConsoleBase.sessionMaxSize` *** ### sessionSize? > `optional` **sessionSize?**: `number` Defined in: [extensions/scribunto.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L37) Bytes used so far in the session (content plus accumulated questions). #### Inherited from `ApiScribuntoConsoleBase.sessionSize` *** ### type? > `optional` **type?**: [`ScribuntoConsoleType`](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ScribuntoConsoleType.md) Defined in: [extensions/scribunto.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L31) Whether the question evaluated cleanly (`normal`) or raised a Lua error (`error`). #### Inherited from `ApiScribuntoConsoleBase.type` --- url: https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleResponse.md --- > 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. # Type Alias: ApiScribuntoConsoleResponse > **ApiScribuntoConsoleResponse** = [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) & [`ApiScribuntoConsoleNormal`](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleNormal.md) | [`ApiScribuntoConsoleError`](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleError.md) Defined in: [extensions/scribunto.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L72) Response of `action=scribunto-console`. Discriminated on type: a [ApiScribuntoConsoleNormal](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleNormal.md) result or an [ApiScribuntoConsoleError](https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ApiScribuntoConsoleError.md) one, both merged onto the envelope at the root. --- url: https://types-mediawiki-response.pages.dev/api/extensions/scribunto/ScribuntoConsoleType.md --- > 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. # Type Alias: ScribuntoConsoleType > **ScribuntoConsoleType** = `"normal"` | `"error"` | `string` & `object` Defined in: [extensions/scribunto.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/scribunto.ts#L26) Console outcome. Scribunto reports `normal` / `error` in band; open for future kinds. --- url: https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/overview.md --- > 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. # SiteMatrix ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiSiteMatrixLanguage](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixLanguage.md) | One language row of the matrix: every wiki in that language. | | [ApiSiteMatrixResponse](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResponse.md) | Response of `action=sitematrix`. | | [ApiSiteMatrixResult](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResult.md) | The `sitematrix` object: `count`, `specials` and one key per language (numeric strings, `"0"`, `"1"`, …), so entries keep an open index signature. | | [ApiSiteMatrixSite](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSite.md) | One project-family wiki of a language entry. | | [ApiSiteMatrixSpecial](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSpecial.md) | One special (non-language-split) wiki, e.g. `www.mediawiki.org`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixLanguage.md --- > 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: ApiSiteMatrixLanguage Defined in: [extensions/sitematrix.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L47) One language row of the matrix: every wiki in that language. ## Properties ### code? > `optional` **code?**: `string` Defined in: [extensions/sitematrix.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L49) Language host code (dashes preserved, e.g. `zh-min-nan`). *** ### dir? > `optional` **dir?**: `"ltr"` | `"rtl"` Defined in: [extensions/sitematrix.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L58) Text direction of the language. *** ### localname? > `optional` **localname?**: `string` Defined in: [extensions/sitematrix.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L55) Localized language name (in the interface language); `smlangprop=localname`. *** ### name? > `optional` **name?**: `string` | `null` Defined in: [extensions/sitematrix.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L52) Language name in the language itself (autonym), e.g. `Deutsch`. *** ### site? > `optional` **site?**: [`ApiSiteMatrixSite`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSite.md)\[] Defined in: [extensions/sitematrix.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L61) Wikis of this language in each project family. --- url: https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResponse.md --- > 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: ApiSiteMatrixResponse Defined in: [extensions/sitematrix.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L113) Response of `action=sitematrix`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### sitematrix > **sitematrix**: [`ApiSiteMatrixResult`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResult.md) Defined in: [extensions/sitematrix.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L115) Result of `action=sitematrix`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixResult.md --- > 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: ApiSiteMatrixResult Defined in: [extensions/sitematrix.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L101) The `sitematrix` object: `count`, `specials` and one key per language (numeric strings, `"0"`, `"1"`, …), so entries keep an open index signature. ## Indexable > \[`lang`: `string`]: `number` | [`ApiSiteMatrixLanguage`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixLanguage.md) | [`ApiSiteMatrixSpecial`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSpecial.md)\[] | `undefined` Language entries keyed by numeric string. ## Properties ### count? > `optional` **count?**: `number` Defined in: [extensions/sitematrix.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L103) Total number of wikis in the matrix. *** ### specials? > `optional` **specials?**: [`ApiSiteMatrixSpecial`](https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSpecial.md)\[] Defined in: [extensions/sitematrix.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L106) Special (non-language-split) wikis; only with `smtype=special` (default). --- url: https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSite.md --- > 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: ApiSiteMatrixSite Defined in: [extensions/sitematrix.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L26) One project-family wiki of a language entry. ## Properties ### closed? > `optional` **closed?**: `boolean` Defined in: [extensions/sitematrix.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L43) Whether the wiki is closed for editing; `smsiteprop` irrelevant. *** ### code? > `optional` **code?**: `string` Defined in: [extensions/sitematrix.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L34) Project family code, e.g. `wiki`. *** ### dbname? > `optional` **dbname?**: `string` Defined in: [extensions/sitematrix.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L31) Database name, `` for language-split sites (e.g. `wiki`). *** ### lang? > `optional` **lang?**: `string` Defined in: [extensions/sitematrix.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L37) Wiki content language (BCP 47); requires `smsiteprop=lang`. *** ### sitename? > `optional` **sitename?**: `string` Defined in: [extensions/sitematrix.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L40) Site name of the wiki. *** ### url? > `optional` **url?**: `string` Defined in: [extensions/sitematrix.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L28) Canonical server URL of the wiki. --- url: https://types-mediawiki-response.pages.dev/api/extensions/sitematrix/ApiSiteMatrixSpecial.md --- > 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: ApiSiteMatrixSpecial Defined in: [extensions/sitematrix.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L65) One special (non-language-split) wiki, e.g. `www.mediawiki.org`. ## Properties ### closed? > `optional` **closed?**: `boolean` Defined in: [extensions/sitematrix.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L94) Whether the wiki is closed for editing. *** ### code? > `optional` **code?**: `string` Defined in: [extensions/sitematrix.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L76) Wiki code without the family suffix, e.g. `mediawiki` (the corresponding [dbname](#dbname) is `mediawikiwiki`). *** ### dbname? > `optional` **dbname?**: `string` Defined in: [extensions/sitematrix.ts:70](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L70) Database name, e.g. `mediawikiwiki`. *** ### fishbowl? > `optional` **fishbowl?**: `boolean` Defined in: [extensions/sitematrix.ts:88](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L88) Whether the wiki is fishbowl (read-public, write-restricted); special wikis only. *** ### lang? > `optional` **lang?**: `string` Defined in: [extensions/sitematrix.ts:79](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L79) Wiki content language (BCP 47). *** ### nonglobal? > `optional` **nonglobal?**: `boolean` Defined in: [extensions/sitematrix.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L91) Whether the wiki is excluded from SUL; only reported for special wikis. *** ### private? > `optional` **private?**: `boolean` Defined in: [extensions/sitematrix.ts:85](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L85) Whether the wiki is private; only reported for special wikis. *** ### sitename? > `optional` **sitename?**: `string` Defined in: [extensions/sitematrix.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L82) Site name of the wiki. *** ### url? > `optional` **url?**: `string` Defined in: [extensions/sitematrix.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/sitematrix.ts#L67) Canonical server URL of the wiki. --- url: https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/overview.md --- > 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. # SpamBlacklist ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | [ApiSpamBlacklistResponse](https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/ApiSpamBlacklistResponse.md) | Response of `action=spamblacklist`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/spamblacklist/ApiSpamBlacklistResponse.md --- > 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: ApiSpamBlacklistResponse Defined in: [extensions/spamblacklist.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/spamblacklist.ts#L19) Response of `action=spamblacklist`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### spamblacklist > **spamblacklist**: `object` Defined in: [extensions/spamblacklist.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/spamblacklist.ts#L21) Result of `action=spamblacklist`. #### matches? > `optional` **matches?**: `string`\[] The matching blacklist lines (present when `result` is `blacklisted`). #### result? > `optional` **result?**: `string` & `object` | `"ok"` | `"blacklisted"` Whether the URL matched the blacklist. Open union for forward compat. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/overview.md --- > 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. # TemplateData ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | [ApiTemplateDataPage](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataPage.md) | One entry of `pages`, keyed by page id. | | [ApiTemplateDataParam](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataParam.md) | One parameter description (`params.`). | | [ApiTemplateDataResponse](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataResponse.md) | Response of `action=templatedata`, which returns no continuation cursors: every requested page arrives in a single reply. | | [ApiTemplateDataRoot](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md) | The stored TemplateData block of one template. | | [ApiTemplateDataSet](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataSet.md) | A group of parameters presented together (`sets[]`). | ## Type Aliases | Type Alias | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiTemplateDataMap](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataMap.md) | A consumer-specific mapping (`maps.`). Keys are consumer-defined and not validated; each value references parameters of the template — a parameter name, a list of names, or a list of lists of names. | | [ApiTemplateDataText](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | InterfaceText as served: a map keyed by language code (`{"en": "Nowrap?"}`). A plain string only when the request passes `lang`, which resolves each text to a single language (requested language, then its fallbacks, then the site content language). | | [TemplateDataType](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/TemplateDataType.md) | Parameter type a template expects, as accepted by the validator (`content`, `line`, `number`, `boolean`, `string`, `date`, `unbalanced-wikitext`, `unknown`, `url`, `wiki-page-name`, `wiki-user-name`, `wiki-file-name`, `wiki-template-name`). Hook handlers may register additional names, so consumers must tolerate values outside this list. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataMap.md --- > 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. # Type Alias: ApiTemplateDataMap > **ApiTemplateDataMap** = `Record`\<`string`, `string` | `string`\[] | `string`\[]\[]> Defined in: [extensions/templatedata.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L116) A consumer-specific mapping (`maps.`). Keys are consumer-defined and not validated; each value references parameters of the template — a parameter name, a list of names, or a list of lists of names. --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataPage.md --- > 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: ApiTemplateDataPage Defined in: [extensions/templatedata.ts:150](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L150) One entry of `pages`, keyed by page id. ## Extends - [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md) ## Properties ### description? > `optional` **description?**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | `null` Defined in: [extensions/templatedata.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L121) One-line description of the template. #### Inherited from [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md).[`description`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md#description) *** ### format? > `optional` **format?**: `string` & `object` | `"block"` | `"inline"` | `null` Defined in: [extensions/templatedata.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L146) Preferred transclusion layout, or a FormatString. #### Inherited from [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md).[`format`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md#format) *** ### maps? > `optional` **maps?**: `unknown`\[] | `Record`\<`string`, [`ApiTemplateDataMap`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataMap.md)> Defined in: [extensions/templatedata.ts:143](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L143) Consumer-specific maps, keyed by consumer identifier. #### Inherited from [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md).[`maps`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md#maps) *** ### missing? > `optional` **missing?**: `true` Defined in: [extensions/templatedata.ts:155](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L155) `true` for a requested title that does not exist. *** ### notemplatedata? > `optional` **notemplatedata?**: `true` Defined in: [extensions/templatedata.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L158) `true` when the page exists but carries no `` block. *** ### paramOrder? > `optional` **paramOrder?**: `string`\[] Defined in: [extensions/templatedata.ts:134](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L134) Parameter order for display — a complete permutation of the keys of `params`; the validator rejects a partial or duplicated list. #### Inherited from [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md).[`paramOrder`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md#paramorder) *** ### params? > `optional` **params?**: `unknown`\[] | `Record`\<`string`, `unknown`\[] | [`ApiTemplateDataParam`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataParam.md)> Defined in: [extensions/templatedata.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L128) Parameter descriptions, keyed by parameter name. Full objects for pages with TemplateData; for `notemplatedata` pages only the names extracted from raw wikitext, each mapping to an empty entry. #### Inherited from [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md).[`params`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md#params) *** ### sets? > `optional` **sets?**: [`ApiTemplateDataSet`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataSet.md)\[] Defined in: [extensions/templatedata.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L140) Parameter groups. An **array** of [ApiTemplateDataSet](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataSet.md) (the stored shape; a map there is rejected with `templatedata-invalid-type`). #### Inherited from [`ApiTemplateDataRoot`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md).[`sets`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md#sets) *** ### title? > `optional` **title?**: `string` Defined in: [extensions/templatedata.ts:152](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L152) Page title. --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataParam.md --- > 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: ApiTemplateDataParam Defined in: [extensions/templatedata.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L64) One parameter description (`params.`). ## Properties ### aliases? > `optional` **aliases?**: `string`\[] Defined in: [extensions/templatedata.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L84) Other names this parameter answers to. *** ### autovalue? > `optional` **autovalue?**: `string` | `null` Defined in: [extensions/templatedata.ts:90](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L90) Value auto-inserted when the parameter is used, e.g. `{{subst:CURRENTYEAR}}`. *** ### default? > `optional` **default?**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | `null` Defined in: [extensions/templatedata.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L93) Assumed value when the parameter is absent from a transclusion. *** ### deprecated? > `optional` **deprecated?**: `string` | `boolean` Defined in: [extensions/templatedata.ts:81](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L81) Discouraged. Either a boolean or, better, the text explaining what to use instead. *** ### description? > `optional` **description?**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | `null` Defined in: [extensions/templatedata.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L69) Longer explanation shown to editors. *** ### example? > `optional` **example?**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | `null` Defined in: [extensions/templatedata.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L99) Example value shown to help editors. *** ### label? > `optional` **label?**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | `null` Defined in: [extensions/templatedata.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L66) Display label. *** ### required? > `optional` **required?**: `boolean` Defined in: [extensions/templatedata.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L72) The template does not work without it. Defaults to `false`. *** ### suggested? > `optional` **suggested?**: `boolean` Defined in: [extensions/templatedata.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L75) Worth filling in but not mandatory. Defaults to `false`. *** ### suggestedvalues? > `optional` **suggestedvalues?**: `string`\[] Defined in: [extensions/templatedata.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L96) Commonly used values offered as completion; free text stays allowed. *** ### type? > `optional` **type?**: [`TemplateDataType`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/TemplateDataType.md) Defined in: [extensions/templatedata.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L87) Expected kind of the value. --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataResponse.md --- > 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: ApiTemplateDataResponse Defined in: [extensions/templatedata.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L165) Response of `action=templatedata`, which returns no continuation cursors: every requested page arrives in a single reply. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### normalized? > `optional` **normalized?**: [`ApiQueryNormalized`](https://types-mediawiki-response.pages.dev/api/core/ApiQueryNormalized.md)\[] Defined in: [extensions/templatedata.ts:167](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L167) Title normalizations applied to the request. *** ### pages > **pages**: `Record`\<`string`, [`ApiTemplateDataPage`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataPage.md)> Defined in: [extensions/templatedata.ts:173](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L173) Entries keyed by page id (negative for missing titles). *** ### redirects? > `optional` **redirects?**: [`ApiRedirect`](https://types-mediawiki-response.pages.dev/api/core/ApiRedirect.md)\[] Defined in: [extensions/templatedata.ts:170](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L170) Redirects followed to reach the requested titles. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataRoot.md --- > 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: ApiTemplateDataRoot Defined in: [extensions/templatedata.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L119) The stored TemplateData block of one template. ## Extended by - [`ApiTemplateDataPage`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataPage.md) ## Properties ### description? > `optional` **description?**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) | `null` Defined in: [extensions/templatedata.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L121) One-line description of the template. *** ### format? > `optional` **format?**: `string` & `object` | `"block"` | `"inline"` | `null` Defined in: [extensions/templatedata.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L146) Preferred transclusion layout, or a FormatString. *** ### maps? > `optional` **maps?**: `unknown`\[] | `Record`\<`string`, [`ApiTemplateDataMap`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataMap.md)> Defined in: [extensions/templatedata.ts:143](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L143) Consumer-specific maps, keyed by consumer identifier. *** ### paramOrder? > `optional` **paramOrder?**: `string`\[] Defined in: [extensions/templatedata.ts:134](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L134) Parameter order for display — a complete permutation of the keys of `params`; the validator rejects a partial or duplicated list. *** ### params? > `optional` **params?**: `unknown`\[] | `Record`\<`string`, `unknown`\[] | [`ApiTemplateDataParam`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataParam.md)> Defined in: [extensions/templatedata.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L128) Parameter descriptions, keyed by parameter name. Full objects for pages with TemplateData; for `notemplatedata` pages only the names extracted from raw wikitext, each mapping to an empty entry. *** ### sets? > `optional` **sets?**: [`ApiTemplateDataSet`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataSet.md)\[] Defined in: [extensions/templatedata.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L140) Parameter groups. An **array** of [ApiTemplateDataSet](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataSet.md) (the stored shape; a map there is rejected with `templatedata-invalid-type`). --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataSet.md --- > 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: ApiTemplateDataSet Defined in: [extensions/templatedata.ts:103](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L103) A group of parameters presented together (`sets[]`). ## Properties ### label > **label**: [`ApiTemplateDataText`](https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md) Defined in: [extensions/templatedata.ts:105](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L105) Set label. Required by the validator. *** ### params > **params**: `string`\[] Defined in: [extensions/templatedata.ts:108](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L108) Names of the parameters this set groups. Required and non-empty. --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/ApiTemplateDataText.md --- > 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. # Type Alias: ApiTemplateDataText > **ApiTemplateDataText** = `string` | `Record`\<`string`, `string`> Defined in: [extensions/templatedata.ts:61](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L61) InterfaceText as served: a map keyed by language code (`{"en": "Nowrap?"}`). A plain string only when the request passes `lang`, which resolves each text to a single language (requested language, then its fallbacks, then the site content language). --- url: https://types-mediawiki-response.pages.dev/api/extensions/templatedata/TemplateDataType.md --- > 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. # Type Alias: TemplateDataType > **TemplateDataType** = `"boolean"` | `"content"` | `"date"` | `"line"` | `"number"` | `"string"` | `"unbalanced-wikitext"` | `"unknown"` | `"url"` | `"wiki-file-name"` | `"wiki-page-name"` | `"wiki-template-name"` | `"wiki-user-name"` | `string` & `object` Defined in: [extensions/templatedata.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/templatedata.ts#L39) Parameter type a template expects, as accepted by the validator (`content`, `line`, `number`, `boolean`, `string`, `date`, `unbalanced-wikitext`, `unknown`, `url`, `wiki-page-name`, `wiki-user-name`, `wiki-file-name`, `wiki-template-name`). Hook handlers may register additional names, so consumers must tolerate values outside this list. --- url: https://types-mediawiki-response.pages.dev/api/extensions/thanks/overview.md --- > 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. # Thanks ## Interfaces | Interface | Description | | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | [ApiThankResponse](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResponse.md) | Response of `action=thank`. | | [ApiThankResult](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResult.md) | The `result` object of a successful `action=thank`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResponse.md --- > 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: ApiThankResponse Defined in: [extensions/thanks.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/thanks.ts#L29) Response of `action=thank`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### result > **result**: [`ApiThankResult`](https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResult.md) Defined in: [extensions/thanks.ts:31](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/thanks.ts#L31) Result of `action=thank`; this module keys its payload `result`, not `thank`. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/thanks/ApiThankResult.md --- > 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: ApiThankResult Defined in: [extensions/thanks.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/thanks.ts#L20) The `result` object of a successful `action=thank`. ## Properties ### recipient > **recipient**: `string` Defined in: [extensions/thanks.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/thanks.ts#L25) Canonical name of the thanked user. *** ### success > **success**: `number` Defined in: [extensions/thanks.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/thanks.ts#L22) `1` when the thanks was recorded (also for a duplicate thanks, which pretends success). --- url: https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/overview.md --- > 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. # TimedMediaHandler ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiTranscodeResetResponse](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeResetResponse.md) | Response of `action=transcodereset` (requires the `transcode-reset` right). | | [ApiTranscodeState](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeState.md) | One transcode state of `prop=transcodestatus`, keyed by transcode key (e.g. `240p.vp9.webm`) on the file page. The keys mirror the `transcode` table columns with the `transcode_` prefix stripped. | | [ApiVideoInfo](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoInfo.md) | One video-info entry for a file page: the imageinfo fields (`viprop` mirrors the `iiprop` names) plus TMH's `derivatives` and `timedtext` lists. | | [ApiVideoSource](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoSource.md) | One source of a video's `derivatives` list (the original file first, then each ready transcode). Audio files report `width`/`height` as `0`. | | [ApiVideoTimedTextTrack](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoTimedTextTrack.md) | One subtitle track of `viprop=timedtext` (one entry per track format). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeResetResponse.md --- > 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: ApiTranscodeResetResponse Defined in: [extensions/timedmediahandler.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L156) Response of `action=transcodereset` (requires the `transcode-reset` right). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### success? > `optional` **success?**: `string` Defined in: [extensions/timedmediahandler.ts:158](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L158) `removed transcode` on success; failures are top-level error responses. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiTranscodeState.md --- > 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: ApiTranscodeState Defined in: [extensions/timedmediahandler.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L109) One transcode state of `prop=transcodestatus`, keyed by transcode key (e.g. `240p.vp9.webm`) on the file page. The keys mirror the `transcode` table columns with the `transcode_` prefix stripped. ## Properties ### error? > `optional` **error?**: `string` Defined in: [extensions/timedmediahandler.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L111) Error output of the transcode run; `""` unless the transcode failed. *** ### final_bitrate? > `optional` **final_bitrate?**: `string` | `number` Defined in: [extensions/timedmediahandler.ts:129](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L129) Achieved bitrate in bit/s of the finished transcode; may be a number or a numeric string. *** ### size? > `optional` **size?**: `string` | `null` Defined in: [extensions/timedmediahandler.ts:152](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L152) Size in bytes of the finished transcode, `null` while unfinished; a numeric string. #### Since MediaWiki 1.46 *** ### state? > `optional` **state?**: `string` Defined in: [extensions/timedmediahandler.ts:137](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L137) Transcode job state as a numeric string (e.g. `"3"` while working, `"4"` when ready). #### Since MediaWiki 1.46 *** ### time_addjob? > `optional` **time_addjob?**: `string` | `null` Defined in: [extensions/timedmediahandler.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L114) When the job was queued; a 14-digit MediaWiki timestamp or `null`. *** ### time_error? > `optional` **time_error?**: `string` | `null` Defined in: [extensions/timedmediahandler.ts:123](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L123) When the transcode failed; a 14-digit MediaWiki timestamp or `null`. *** ### time_startwork? > `optional` **time_startwork?**: `string` | `null` Defined in: [extensions/timedmediahandler.ts:117](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L117) When the job started working; a 14-digit MediaWiki timestamp or `null`. *** ### time_success? > `optional` **time_success?**: `string` | `null` Defined in: [extensions/timedmediahandler.ts:120](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L120) When the transcode finished; a 14-digit MediaWiki timestamp or `null`. *** ### touched? > `optional` **touched?**: `string` Defined in: [extensions/timedmediahandler.ts:144](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L144) When the transcode state was last touched; a 14-digit MediaWiki timestamp. #### Since MediaWiki 1.46 --- url: https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoInfo.md --- > 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: ApiVideoInfo Defined in: [extensions/timedmediahandler.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L93) One video-info entry for a file page: the imageinfo fields (`viprop` mirrors the `iiprop` names) plus TMH's `derivatives` and `timedtext` lists. ## Extends - [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md) ## Properties ### anon? > `optional` **anon?**: `true` Defined in: [core/query/imageinfo.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L237) Made by an anonymous (IP) uploader. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`anon`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#anon) *** ### archivename? > `optional` **archivename?**: `string` Defined in: [core/query/imageinfo.ts:231](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L231) Archive name for a historical version. `iiprop=archivename`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`archivename`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#archivename) *** ### bitdepth? > `optional` **bitdepth?**: `number` Defined in: [core/query/imageinfo.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L174) Color bit depth; `0` for files without dimensions (e.g. audio). `iiprop=bitdepth`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`bitdepth`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#bitdepth) *** ### canonicaltitle? > `optional` **canonicaltitle?**: `string` Defined in: [core/query/imageinfo.ts:110](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L110) Canonical localized file title. `iiprop=canonicaltitle`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`canonicaltitle`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#canonicaltitle) *** ### comment? > `optional` **comment?**: `string` Defined in: [core/query/imageinfo.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L89) Raw upload comment. `iiprop=comment`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`comment`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#comment) *** ### commenthidden? > `optional` **commenthidden?**: `true` Defined in: [core/query/shared.ts:28](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L28) The comment is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`commenthidden`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#commenthidden) *** ### commonmetadata? > `optional` **commonmetadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] Defined in: [core/query/imageinfo.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L186) Metadata keys common to all file types, same item shape as [metadata](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#metadata). `iiprop=commonmetadata`; an empty PHP map, so `[]` when there is none. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`commonmetadata`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#commonmetadata) *** ### derivatives? > `optional` **derivatives?**: [`ApiVideoSource`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoSource.md)\[] Defined in: [extensions/timedmediahandler.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L95) Original file source followed by every ready transcode. `viprop=derivatives`. *** ### descriptionshorturl? > `optional` **descriptionshorturl?**: `string` Defined in: [core/query/imageinfo.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L119) Shortened description-page URL. `iiprop=url`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`descriptionshorturl`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#descriptionshorturl) *** ### descriptionurl? > `optional` **descriptionurl?**: `string` Defined in: [core/query/imageinfo.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L116) URL of the file description page. `iiprop=url`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`descriptionurl`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#descriptionurl) *** ### duration? > `optional` **duration?**: `number` Defined in: [core/query/imageinfo.ts:221](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L221) Media duration in seconds (audio/video), when the handler reports one. Emitted under `iiprop=size|dimensions`; there is no `iiprop=duration`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`duration`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#duration) *** ### extmetadata? > `optional` **extmetadata?**: `Record`\<`string`, [`ApiExtMetadataField`](https://types-mediawiki-response.pages.dev/api/core/ApiExtMetadataField.md)> Defined in: [core/query/imageinfo.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L194) Structured/extended metadata keyed by field name. `iiprop=extmetadata`. A bare MediaWiki core only produces `DateTime` and `ObjectName` here; the richer per-file fields (GPS, licensing, …) are contributed by `GetExtendedMetadata` hooks on the serving wiki (e.g. Extension:Metadata). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`extmetadata`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#extmetadata) *** ### filehidden? > `optional` **filehidden?**: `true` Defined in: [core/query/imageinfo.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L234) The file itself is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`filehidden`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#filehidden) *** ### filemissing? > `optional` **filemissing?**: `true` Defined in: [core/query/imageinfo.ts:215](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L215) `true` when the file itself does not exist on this wiki (a stub row). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`filemissing`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#filemissing) *** ### height? > `optional` **height?**: `number` Defined in: [core/query/imageinfo.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L107) Height in pixels; `0` for files without dimensions (e.g. audio). `iiprop=size|dimensions`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`height`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#height) *** ### html? > `optional` **html?**: `string` Defined in: [core/query/imageinfo.ts:212](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L212) Upload-warning HTML ("a file with this name exists already…"). `iiprop=uploadwarning`; `""` when there is nothing to warn about. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`html`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#html) *** ### mediatype? > `optional` **mediatype?**: `string` Defined in: [core/query/imageinfo.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L171) Media type, e.g. `BITMAP`, `OFFICE`, `ARCHIVE`. `iiprop=mediatype`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`mediatype`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#mediatype) *** ### metadata? > `optional` **metadata?**: [`ApiImageMetadataItem`](https://types-mediawiki-response.pages.dev/api/core/ApiImageMetadataItem.md)\[] | `null` Defined in: [core/query/imageinfo.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L180) Raw format metadata (EXIF / PNG chunks / …). `iiprop=metadata`; an explicit `null` when the file has no metadata at all. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`metadata`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#metadata) *** ### mime? > `optional` **mime?**: `string` Defined in: [core/query/imageinfo.ts:168](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L168) MIME type, e.g. `image/png`. `iiprop=mime`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`mime`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#mime) *** ### pagecount? > `optional` **pagecount?**: `number` Defined in: [core/query/imageinfo.ts:228](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L228) Page count (multi-page documents such as PDFs/TIFFs), when the handler supports one. Emitted under `iiprop=size|dimensions`; there is no `iiprop=pagecount`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`pagecount`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#pagecount) *** ### parsedcomment? > `optional` **parsedcomment?**: `string` Defined in: [core/query/imageinfo.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L92) HTML-rendered comment. `iiprop=parsedcomment`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`parsedcomment`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#parsedcomment) *** ### responsiveUrls? > `optional` **responsiveUrls?**: `Record`\<`string`, `string`> Defined in: [core/query/imageinfo.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L162) HiDPI (`2x`, …) source URLs keyed by pixel-density multiplier. Requires `iiprop=url`, plus a successful transform. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`responsiveUrls`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#responsiveurls) *** ### sha1? > `optional` **sha1?**: `string` Defined in: [core/query/imageinfo.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L165) File SHA-1 (hex). `iiprop=sha1`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`sha1`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#sha1) *** ### size? > `optional` **size?**: `number` Defined in: [core/query/imageinfo.ts:95](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L95) File size in bytes. `iiprop=size|dimensions`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`size`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#size) *** ### suppressed? > `optional` **suppressed?**: `true` Defined in: [core/query/shared.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L34) Oversight/suppression applies to the entry (set together with the `*hidden` flags). A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`suppressed`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#suppressed) *** ### temp? > `optional` **temp?**: `true` Defined in: [core/query/imageinfo.ts:244](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L244) The uploader is a temporary account. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Since MediaWiki 1.42 #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`temp`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#temp) *** ### thumbattribs? > `optional` **thumbattribs?**: `Record`\<`string`, `string` | `number`> Defined in: [core/query/imageinfo.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L146) Pre-rendered `` attributes for the thumbnail (e.g. `src`, `width`, `srcset`). #### Since MediaWiki 1.47 #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbattribs`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbattribs) *** ### thumberror? > `optional` **thumberror?**: `string` Defined in: [core/query/imageinfo.ts:206](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L206) Rendered text of the thumbnail error, when the thumbnail could not be made. Requires `iiprop=url`, plus a transform. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumberror`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumberror) *** ### thumbheight? > `optional` **thumbheight?**: `number` Defined in: [core/query/imageinfo.ts:138](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L138) Scaled thumbnail height (px). Falls back to the file's own height like [thumbwidth](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbwidth). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbheight`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbheight) *** ### thumbmime? > `optional` **thumbmime?**: `string` Defined in: [core/query/imageinfo.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L200) MIME type the thumbnail will be rendered as. `iiprop=thumbmime`, which requires `iiprop=url` and a transform via `iiurlwidth`/`iiurlheight`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbmime`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbmime) *** ### thumburl? > `optional` **thumburl?**: `string` Defined in: [core/query/imageinfo.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L125) Scaled thumbnail URL. Requires `iiprop=url`, plus a transform requested via `iiurlwidth`, `iiurlheight` or `iiurlparam`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumburl`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburl) *** ### thumburls? > `optional` **thumburls?**: `Record`\<`string`, [`ApiThumbUrlEntry`](https://types-mediawiki-response.pages.dev/api/core/ApiThumbUrlEntry.md)> Defined in: [core/query/imageinfo.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L156) Scaled thumbnail URLs at multiple widths, keyed by the produced thumbnail's width (normally the requested width; e.g. `"400"`, `"800"`). `iiprop=thumburls`. Each entry also folds in the transform's HTML `` attributes. #### Since MediaWiki 1.47 #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumburls`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburls) *** ### thumbwidth? > `optional` **thumbwidth?**: `number` Defined in: [core/query/imageinfo.ts:132](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L132) Scaled thumbnail width (px). Falls back to the file's own width when the thumbnail URL equals the original URL (no resize happened). Same requirements as [thumburl](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumburl). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`thumbwidth`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#thumbwidth) *** ### timedtext? > `optional` **timedtext?**: [`ApiVideoTimedTextTrack`](https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoTimedTextTrack.md)\[] Defined in: [extensions/timedmediahandler.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L101) Available subtitle tracks (one per language and format); `[]` when the file has none. `viprop=timedtext`. *** ### timestamp? > `optional` **timestamp?**: `string` Defined in: [core/query/imageinfo.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L80) Timestamp of the file's upload/reversion. `iiprop=timestamp`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`timestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#timestamp) *** ### url? > `optional` **url?**: `string` Defined in: [core/query/imageinfo.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L113) Direct URL to the file. `iiprop=url`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`url`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#url) *** ### user? > `optional` **user?**: `string` Defined in: [core/query/imageinfo.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L83) Uploader user name. `iiprop=user`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`user`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#user) *** ### userhidden? > `optional` **userhidden?**: `true` Defined in: [core/query/shared.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/shared.ts#L25) The acting user is hidden. A [Flag](https://types-mediawiki-response.pages.dev/api/core/Flag.md). #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`userhidden`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#userhidden) *** ### userid? > `optional` **userid?**: `number` Defined in: [core/query/imageinfo.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L86) Uploader user id. `iiprop=userid`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`userid`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#userid) *** ### width? > `optional` **width?**: `number` Defined in: [core/query/imageinfo.ts:101](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/imageinfo.ts#L101) Width in pixels; `0` for files without dimensions (e.g. audio). `iiprop=size|dimensions`. #### Inherited from [`ApiImageInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md).[`width`](https://types-mediawiki-response.pages.dev/api/core/ApiImageInfo.md#width) --- url: https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoSource.md --- > 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: ApiVideoSource Defined in: [extensions/timedmediahandler.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L32) One source of a video's `derivatives` list (the original file first, then each ready transcode). Audio files report `width`/`height` as `0`. ## Properties ### bandwidth? > `optional` **bandwidth?**: `number` Defined in: [extensions/timedmediahandler.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L49) Average bandwidth in bit/s, when the handler reports one. *** ### height? > `optional` **height?**: `number` Defined in: [extensions/timedmediahandler.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L46) Video height in pixels (`0` for audio). *** ### shorttitle? > `optional` **shorttitle?**: `string` Defined in: [extensions/timedmediahandler.ts:58](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L58) Short form of [title](#title). *** ### src? > `optional` **src?**: `string` Defined in: [extensions/timedmediahandler.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L34) Direct URL to the file / transcode. *** ### title? > `optional` **title?**: `string` Defined in: [extensions/timedmediahandler.ts:55](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L55) Human-readable label, carried only by the HLS playlist source (`transcodekey` `m3u8`). *** ### transcodekey? > `optional` **transcodekey?**: `string` Defined in: [extensions/timedmediahandler.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L40) Transcode key of a derivative (absent for the original file source). *** ### type? > `optional` **type?**: `string` Defined in: [extensions/timedmediahandler.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L37) MIME type, e.g. `video/webm; codecs="vp9, opus"`. *** ### width? > `optional` **width?**: `number` Defined in: [extensions/timedmediahandler.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L43) Video width in pixels (`0` for audio). --- url: https://types-mediawiki-response.pages.dev/api/extensions/timedmediahandler/ApiVideoTimedTextTrack.md --- > 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: ApiVideoTimedTextTrack Defined in: [extensions/timedmediahandler.ts:62](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L62) One subtitle track of `viprop=timedtext` (one entry per track format). ## Properties ### dir? > `optional` **dir?**: `"ltr"` | `"rtl"` Defined in: [extensions/timedmediahandler.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L83) Text direction of the track language. *** ### kind? > `optional` **kind?**: `string` & `object` | `"subtitles"` Defined in: [extensions/timedmediahandler.ts:74](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L74) Track kind; `subtitles` for the text tracks TMH generates. **Open union**: a track mirrored from a foreign file repository keeps the kind that repository reports. *** ### label? > `optional` **label?**: `string` Defined in: [extensions/timedmediahandler.ts:86](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L86) Human-readable track label including the language name. *** ### src? > `optional` **src?**: `string` Defined in: [extensions/timedmediahandler.ts:67](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L67) URL of the subtitle stream (an `action=timedtext` API URL, already carrying `origin=*` for cross-origin playback). *** ### srclang? > `optional` **srclang?**: `string` Defined in: [extensions/timedmediahandler.ts:80](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L80) Track language (BCP 47). *** ### type? > `optional` **type?**: `string` Defined in: [extensions/timedmediahandler.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/timedmediahandler.ts#L77) MIME type of the track, e.g. `text/x-srt` or `text/vtt`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/overview.md --- > 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. # TitleBlacklist ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | [ApiTitleBlacklistResponse](https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/ApiTitleBlacklistResponse.md) | Response of `action=titleblacklist`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/titleblacklist/ApiTitleBlacklistResponse.md --- > 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: ApiTitleBlacklistResponse Defined in: [extensions/titleblacklist.ts:19](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/titleblacklist.ts#L19) Response of `action=titleblacklist`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### titleblacklist > **titleblacklist**: `object` Defined in: [extensions/titleblacklist.ts:21](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/titleblacklist.ts#L21) Result of `action=titleblacklist`. #### line? > `optional` **line?**: `string` The matching blacklist line, HTML-escaped. Only on a match. #### message? > `optional` **message?**: `string` Message key of the match: the entry's custom message when set, else `titleblacklist-forbidden-{action}` (`create` uses the `edit` variant). Only on a match. #### reason? > `optional` **reason?**: `string` Reason shown to the user (parsed HTML or plain text); only on a match. #### result > **result**: `string` & `object` | `"ok"` | `"blacklisted"` Whether the title matched the blacklist. Open union for forward compat. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/overview.md --- > 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. # Translate ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [ApiAggregateGroupsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResponse.md) | Response of `action=aggregategroups`. | | [ApiAggregateGroupsResult](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResult.md) | Result of `action=aggregategroups` (CSRF-token POST, `translate-manage` right). The fields depend on the requested `do`: creating returns the new group id and the aggregate-able groups, associating returns the target page URL, dissociating and removing return only the marker. | | [ApiGroupReviewResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiGroupReviewResponse.md) | Response of `action=groupreview` (CSRF-token POST, `translate-groupreview` right): the workflow state of one message group for one language was set. Requires `$wgTranslateWorkflowStates` on the wiki; the state names are site-configured. | | [ApiLanguageStatsRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiLanguageStatsRow.md) | One `meta=languagestats` row: completeness of one message group in the requested language. | | [ApiMarkForTranslationResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResponse.md) | Response of `action=markfortranslation`. | | [ApiMarkForTranslationResult](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResult.md) | Result of `action=markfortranslation` (pagetranslation-token POST, `pagetranslation` right): a wiki page was marked for translation, creating its translation units and the `page-` message group. | | [ApiMessageCollectionMetadata](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionMetadata.md) | The `query.metadata` block `list=messagecollection` writes alongside its rows, describing the requested slice of the collection. | | [ApiMessageCollectionRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionRow.md) | One `list=messagecollection` row: a message of the group named in `mcgroup` for the language named in `mclanguage`. `mcprop` controls which fields beyond the mandatory ones appear. | | [ApiMessageGroupStatsRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupStatsRow.md) | One `meta=messagegroupstats` row: completeness of one language in the requested group. | | [ApiMessageGroupSubscriptionResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupSubscriptionResponse.md) | Response of `action=messagegroupsubscription` (CSRF-token POST): the requesting user's subscription to the group was changed. Requires `$wgTranslateEnableMessageGroupSubscription`. | | [ApiMessageTranslation](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageTranslation.md) | One `meta=messagetranslations` row: one existing translation of a message (the title named in `mttitle`). | | [ApiSearchTranslationsDocument](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsDocument.md) | One `action=searchtranslations` match: a document of the translation memory. The fields are fixed by the search index; the result may replace `content` with a highlighted snippet. | | [ApiSearchTranslationsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsResponse.md) | Response of `action=searchtranslations`: full-text search over the translation memories. Only wikis backed by a searchable translation-memory service return hits; the response carries them with a metadata block under the root `search` key. | | [ApiStashedTranslation](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiStashedTranslation.md) | One stashed translation of `action=translationstash` `subaction=query`. | | [ApiTranslateMessageGroup](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateMessageGroup.md) | One `meta=messagegroups` entry. `mgprop` controls which fields appear. The groups themselves are site-defined (wiki pages, YAML files, aggregate definitions), so ids beyond the dynamic `!recent` / `!additions` ones are open-ended. | | [ApiTranslateSandboxActionResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxActionResponse.md) | Response of `action=translatesandbox` with `do=delete` / `do=promote` / `do=remind`: the users were processed, no payload keys are returned. | | [ApiTranslateSandboxCreateResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxCreateResponse.md) | Response of `action=translatesandbox` with `do=create` (registers a sandboxed translator; requires `$wgTranslateUseSandbox`). The `delete` / `promote` / `remind` variants return no payload — an empty [ApiEnvelope](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md). | | [ApiTranslateStatsRow](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md) | The four completeness counters shared by `meta=languagestats` and `meta=messagegroupstats` rows. A row appears only once its statistics are available; while they are still being computed the result is a continue instead. | | [ApiTranslateWorkflowState](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateWorkflowState.md) | One workflow state of a message group (`meta=messagegroups` + `mgprop=workflowstates`). | | [ApiTranslationAid](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) | Payload of one translation aid of `action=translationaids`, keyed by aid type (the registry is hook-extensible, so the set is open). An aid that cannot run reports [ApiTranslationAid.error](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md#error) instead of its data. | | [ApiTranslationAidsPayload](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsPayload.md) | The `helpers` map of `action=translationaids`. Members are the aid types of the [TranslationAids registry](https://www.mediawiki.org/wiki/Manual:Hooks/TranslationAids) — the built-in ones are declared here for autocomplete, the index signature keeps hook-registered aids usable. | | [ApiTranslationAidsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsResponse.md) | Response of `action=translationaids` (root-level `helpers` and `times`). | | [ApiTranslationEntitySearchGroup](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchGroup.md) | One message group match of `action=translationentitysearch`. | | [ApiTranslationEntitySearchMessage](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchMessage.md) | One message prefix match of `action=translationentitysearch`. | | [ApiTranslationEntitySearchResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResponse.md) | Response of `action=translationentitysearch`. | | [ApiTranslationEntitySearchResult](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResult.md) | Result of `action=translationentitysearch`: message group and message key prefixes matching the query. Keys are absent when the entity type was not requested or nothing matched. | | [ApiTranslationReviewResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationReviewResponse.md) | Result of `action=translationreview` (CSRF-token POST, `translate-messagereview` right): one translation revision was marked as reviewed. Reviewing one's own translation, fuzzy translations and already reviewed revisions are errors / warnings. | | [ApiTranslationStashResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStashResponse.md) | Response of `action=translationstash` (CSRF-token POST): `subaction=add` returns only the marker, `subaction=query` additionally lists the stashed translations of the requesting (sandbox) user. | | [ApiTranslationStatsResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStatsResponse.md) | Response of `action=translationstats`: graph data for the requested series. | | [ApiTtmServerResponse](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerResponse.md) | Response of `action=ttmserver`. | | [ApiTtmServerSuggestion](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerSuggestion.md) | One suggestion of `action=ttmserver`: a translation-memory hit for the requested text. The fields are supplied by the configured translation-memory service; a unit from the local memory carries the fields below. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResponse.md --- > 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: ApiAggregateGroupsResponse Defined in: [extensions/translate.ts:450](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L450) Response of `action=aggregategroups`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### aggregategroups > **aggregategroups**: [`ApiAggregateGroupsResult`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResult.md) Defined in: [extensions/translate.ts:452](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L452) Result of `action=aggregategroups`. *** ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiAggregateGroupsResult.md --- > 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: ApiAggregateGroupsResult Defined in: [extensions/translate.ts:432](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L432) Result of `action=aggregategroups` (CSRF-token POST, `translate-manage` right). The fields depend on the requested `do`: creating returns the new group id and the aggregate-able groups, associating returns the target page URL, dissociating and removing return only the marker. ## Properties ### aggregategroupId? > `optional` **aggregategroupId?**: `string` Defined in: [extensions/translate.ts:443](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L443) Id of the created aggregate group. Returned by `do=add`. *** ### groups? > `optional` **groups?**: `Record`\<`string`, `string`> Defined in: [extensions/translate.ts:440](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L440) Groups that can be added to the new aggregate group, keyed by group id with their labels as values. Returned by `do=add`. *** ### groupUrl? > `optional` **groupUrl?**: `string` Defined in: [extensions/translate.ts:446](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L446) Full URL of the associated group's translation page. `do=associate`. *** ### result > **result**: `"ok"` Defined in: [extensions/translate.ts:434](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L434) Fixed `ok` marker; failures are standard top-level errors. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiGroupReviewResponse.md --- > 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: ApiGroupReviewResponse Defined in: [extensions/translate.ts:410](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L410) Response of `action=groupreview` (CSRF-token POST, `translate-groupreview` right): the workflow state of one message group for one language was set. Requires `$wgTranslateWorkflowStates` on the wiki; the state names are site-configured. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### groupreview > **groupreview**: `object` Defined in: [extensions/translate.ts:411](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L411) #### review > **review**: `object` Result of `action=groupreview`. ##### review\.group > **group**: `string` Message group id the state was set for. ##### review\.language > **language**: `string` Language code the state was set for. ##### review\.state > **state**: `string` The new workflow state, as configured on the wiki. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiLanguageStatsRow.md --- > 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: ApiLanguageStatsRow Defined in: [extensions/translate.ts:146](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L146) One `meta=languagestats` row: completeness of one message group in the requested language. ## Extends - [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md) ## Properties ### fuzzy > **fuzzy**: `number` Defined in: [extensions/translate.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L136) Number of out-of-date (fuzzy) translations. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`fuzzy`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#fuzzy) *** ### group > **group**: `string` Defined in: [extensions/translate.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L148) Message group id the row counts. *** ### proofread > **proofread**: `number` Defined in: [extensions/translate.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L139) Number of proofread translations. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`proofread`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#proofread) *** ### total > **total**: `number` Defined in: [extensions/translate.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L130) Total number of messages. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`total`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#total) *** ### translated > **translated**: `number` Defined in: [extensions/translate.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L133) Number of translated (non-fuzzy) messages. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`translated`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#translated) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResponse.md --- > 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: ApiMarkForTranslationResponse Defined in: [extensions/translate.ts:377](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L377) Response of `action=markfortranslation`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### markfortranslation > **markfortranslation**: [`ApiMarkForTranslationResult`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResult.md) Defined in: [extensions/translate.ts:379](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L379) Result of `action=markfortranslation`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMarkForTranslationResult.md --- > 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: ApiMarkForTranslationResult Defined in: [extensions/translate.ts:365](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L365) Result of `action=markfortranslation` (pagetranslation-token POST, `pagetranslation` right): a wiki page was marked for translation, creating its translation units and the `page-<title>` message group. ## Properties ### firstmark > **firstmark**: `boolean` Defined in: [extensions/translate.ts:370](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L370) Whether this was the first time the page was marked. *** ### result > **result**: `"Success"` Defined in: [extensions/translate.ts:367](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L367) Fixed `Success` marker; failures are standard top-level errors. *** ### unitcount > **unitcount**: `number` Defined in: [extensions/translate.ts:373](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L373) Number of translation units created (including the page title). --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionMetadata.md --- > 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: ApiMessageCollectionMetadata Defined in: [extensions/translate.ts:237](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L237) The `query.metadata` block `list=messagecollection` writes alongside its rows, describing the requested slice of the collection. ## Properties ### remaining > **remaining**: `number` Defined in: [extensions/translate.ts:248](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L248) Rows after this slice, i.e. `resultsize` minus the rows returned. *** ### resultsize > **resultsize**: `number` Defined in: [extensions/translate.ts:245](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L245) Number of messages matching the requested filters. *** ### state > **state**: `string` | `null` Defined in: [extensions/translate.ts:242](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L242) Review workflow state of the group for the requested language; `null` when the group has no workflow states configured. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageCollectionRow.md --- > 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: ApiMessageCollectionRow Defined in: [extensions/translate.ts:194](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L194) One `list=messagecollection` row: a message of the group named in `mcgroup` for the language named in `mclanguage`. `mcprop` controls which fields beyond the mandatory ones appear. ## Properties ### definition? > `optional` **definition?**: `string` Defined in: [extensions/translate.ts:208](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L208) Source-language definition. `mcprop=definition`. *** ### key > **key**: `string` Defined in: [extensions/translate.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L196) Message key, e.g. `Example/1`. *** ### primaryGroup? > `optional` **primaryGroup?**: `string` Defined in: [extensions/translate.ts:205](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L205) Id of the group the message belongs to. *** ### properties? > `optional` **properties?**: `Record`\<`string`, `string` | `null`> Defined in: [extensions/translate.ts:224](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L224) Per-message metadata (e.g. `status`, `last-translator-text`, `last-translator-id`, `revision`) keyed by property name; values may be `null` for untranslated messages. `mcprop=properties`. *** ### ~~revision?~~ > `optional` **revision?**: `string` | `number` Defined in: [extensions/translate.ts:230](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L230) Revision of the translated unit. `mcprop=revision`. #### Deprecated Superseded by `properties.revision`; removed in MediaWiki 1.44. *** ### tags? > `optional` **tags?**: `string`\[] Defined in: [extensions/translate.ts:217](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L217) Change tags of the translation, `[]` when untagged. `mcprop=tags`. *** ### targetLanguage > **targetLanguage**: `string` Defined in: [extensions/translate.ts:202](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L202) Language the collection was requested for (`mclanguage`). *** ### title > **title**: `string` Defined in: [extensions/translate.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L199) Title of the translation subpage for this message and language. *** ### translation? > `optional` **translation?**: `string` | `null` Defined in: [extensions/translate.ts:214](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L214) Translation in the requested language; `null` when the message is untranslated. `mcprop=translation`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupStatsRow.md --- > 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: ApiMessageGroupStatsRow Defined in: [extensions/translate.ts:155](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L155) One `meta=messagegroupstats` row: completeness of one language in the requested group. ## Extends - [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md) ## Properties ### ~~code~~ > **code**: `string` Defined in: [extensions/translate.ts:162](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L162) Language code of the row. Kept for backwards compatibility; newer clients should read [ApiMessageGroupStatsRow.language](#language). #### Deprecated Superseded by `language`. *** ### fuzzy > **fuzzy**: `number` Defined in: [extensions/translate.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L136) Number of out-of-date (fuzzy) translations. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`fuzzy`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#fuzzy) *** ### language > **language**: `string` Defined in: [extensions/translate.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L165) Language code of the row. *** ### proofread > **proofread**: `number` Defined in: [extensions/translate.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L139) Number of proofread translations. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`proofread`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#proofread) *** ### total > **total**: `number` Defined in: [extensions/translate.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L130) Total number of messages. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`total`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#total) *** ### translated > **translated**: `number` Defined in: [extensions/translate.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L133) Number of translated (non-fuzzy) messages. #### Inherited from [`ApiTranslateStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md).[`translated`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md#translated) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupSubscriptionResponse.md --- > 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: ApiMessageGroupSubscriptionResponse Defined in: [extensions/translate.ts:557](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L557) Response of `action=messagegroupsubscription` (CSRF-token POST): the requesting user's subscription to the group was changed. Requires `$wgTranslateEnableMessageGroupSubscription`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### messagegroupsubscription > **messagegroupsubscription**: `object` Defined in: [extensions/translate.ts:558](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L558) #### group > **group**: `object` The group whose subscription changed. ##### group.id > **id**: `string` Message group id. ##### group.label > **label**: `string` Localized group label. #### success > **success**: `1` Fixed `1` success marker; failures are standard top-level errors. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageTranslation.md --- > 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: ApiMessageTranslation Defined in: [extensions/translate.ts:172](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L172) One `meta=messagetranslations` row: one existing translation of a message (the title named in `mttitle`). ## Properties ### fuzzy? > `optional` **fuzzy?**: `"fuzzy"` Defined in: [extensions/translate.ts:186](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L186) The translation is marked out-of-date (fuzzy); a literal marker. *** ### language > **language**: `string` Defined in: [extensions/translate.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L177) Language code of the translation. *** ### lasttranslator > **lasttranslator**: `string` Defined in: [extensions/translate.ts:180](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L180) Name of the last translator. *** ### title > **title**: `string` Defined in: [extensions/translate.ts:174](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L174) Title of the translation subpage, e.g. `Translations:Example/1/de`. *** ### translation > **translation**: `string` Defined in: [extensions/translate.ts:183](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L183) The translation text (fuzzy marker stripped). --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsDocument.md --- > 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: ApiSearchTranslationsDocument Defined in: [extensions/translate.ts:578](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L578) One `action=searchtranslations` match: a document of the translation memory. The fields are fixed by the search index; the result may replace `content` with a highlighted snippet. ## Properties ### content > **content**: `string` Defined in: [extensions/translate.ts:595](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L595) The indexed text (translation or definition), possibly highlighted. *** ### group > **group**: `string`\[] Defined in: [extensions/translate.ts:592](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L592) Message group ids the unit belongs to. *** ### language > **language**: `string` Defined in: [extensions/translate.ts:589](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L589) Language code of the indexed translation. *** ### localid > **localid**: `string` Defined in: [extensions/translate.ts:586](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L586) Base title of the translation unit, e.g. `Example`. *** ### uri > **uri**: `string` Defined in: [extensions/translate.ts:583](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L583) Canonical URL of the translation page. *** ### wiki > **wiki**: `string` Defined in: [extensions/translate.ts:580](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L580) Wiki id the indexed translation belongs to. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsResponse.md --- > 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: ApiSearchTranslationsResponse Defined in: [extensions/translate.ts:604](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L604) Response of `action=searchtranslations`: full-text search over the translation memories. Only wikis backed by a searchable translation-memory service return hits; the response carries them with a metadata block under the root `search` key. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### search > **search**: `object` Defined in: [extensions/translate.ts:605](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L605) #### metadata > **metadata**: `object` Hit metadata. ##### metadata.total > **total**: `number` Total number of hits. #### translations > **translations**: [`ApiSearchTranslationsDocument`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiSearchTranslationsDocument.md)\[] Hits, best match first; `[]` when nothing matched. *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiStashedTranslation.md --- > 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: ApiStashedTranslation Defined in: [extensions/translate.ts:520](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L520) One stashed translation of `action=translationstash` `subaction=query`. ## Properties ### comparison > **comparison**: `string` | `null` Defined in: [extensions/translate.ts:531](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L531) Current translation in the target language, `null` when untranslated. *** ### definition > **definition**: `string` Defined in: [extensions/translate.ts:525](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L525) Source-language definition; `""` when the message handle is unknown. *** ### metadata > **metadata**: `unknown` Defined in: [extensions/translate.ts:534](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L534) Arbitrary metadata passed when stashing (an empty map decodes to `[]`). *** ### title > **title**: `string` Defined in: [extensions/translate.ts:522](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L522) Title the stashed translation belongs to, e.g. `Translations:Page/2/nl`. *** ### translation > **translation**: `string` Defined in: [extensions/translate.ts:528](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L528) The stashed translation text. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateMessageGroup.md --- > 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: ApiTranslateMessageGroup Defined in: [extensions/translate.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L39) One `meta=messagegroups` entry. `mgprop` controls which fields appear. The groups themselves are site-defined (wiki pages, YAML files, aggregate definitions), so ids beyond the dynamic `!recent` / `!additions` ones are open-ended. ## Properties ### class? > `optional` **class?**: `string` Defined in: [extensions/translate.ts:50](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L50) PHP class backing the group, e.g. `WikiPageMessageGroup`. `mgprop=class`. *** ### description? > `optional` **description?**: `string` Defined in: [extensions/translate.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L47) Localized group description. `mgprop=description`. *** ### exists? > `optional` **exists?**: `boolean` Defined in: [extensions/translate.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L60) Whether the group currently exists (real `boolean`). `mgprop=exists`. *** ### groupcount? > `optional` **groupcount?**: `number` Defined in: [extensions/translate.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L104) Number of nested groups folded into this entry (`mgformat=tree` with `mgdepth` reached). *** ### groups? > `optional` **groups?**: `ApiTranslateMessageGroup`\[] Defined in: [extensions/translate.ts:107](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L107) Child groups (`mgformat=tree` above the depth cutoff). *** ### icon? > `optional` **icon?**: `Record`\<`string`, `unknown`> Defined in: [extensions/translate.ts:65](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L65) Icon URLs keyed by size. `mgprop=icon`; absent for groups without an icon. *** ### id? > `optional` **id?**: `string` Defined in: [extensions/translate.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L41) Group id, e.g. `page-Example`, `!recent`. `mgprop=id`. *** ### label? > `optional` **label?**: `string` Defined in: [extensions/translate.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L44) Localized group label. `mgprop=label`. *** ### namespace? > `optional` **namespace?**: `number` | `false` Defined in: [extensions/translate.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L57) Namespace the group's messages live in, e.g. `1198` (the Translations namespace) for page groups; `false` for groups without a namespace (the dynamic `!recent` / `!additions` ones). `mgprop=namespace`. *** ### priority? > `optional` **priority?**: `string` & `object` | `"default"` Defined in: [extensions/translate.ts:71](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L71) Translation priority. Beyond the core `default`, values are site-defined (set through the group's priority metadata). *** ### priorityforce? > `optional` **priorityforce?**: `boolean` Defined in: [extensions/translate.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L83) Whether translation to non-priority languages is prevented. `mgprop=priorityforce`. *** ### prioritylangs? > `optional` **prioritylangs?**: `false` | `string`\[] Defined in: [extensions/translate.ts:77](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L77) Priority languages of the group, or `false` when unset. `mgprop=prioritylangs`. *** ### sourcelanguage? > `optional` **sourcelanguage?**: `string` Defined in: [extensions/translate.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L92) Source language of the group's messages. `mgprop=sourcelanguage`. *** ### subscription? > `optional` **subscription?**: `boolean` Defined in: [extensions/translate.ts:98](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L98) Whether the current user is subscribed to group updates. `mgprop=subscription`; absent when group subscription is disabled or unavailable to the user. *** ### workflowstates? > `optional` **workflowstates?**: `false` | `Record`\<`string`, [`ApiTranslateWorkflowState`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateWorkflowState.md)> Defined in: [extensions/translate.ts:89](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L89) Workflow states of the group keyed by state id, or `false` when the group has none. `mgprop=workflowstates`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxActionResponse.md --- > 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: ApiTranslateSandboxActionResponse Defined in: [extensions/translate.ts:517](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L517) Response of `action=translatesandbox` with `do=delete` / `do=promote` / `do=remind`: the users were processed, no payload keys are returned. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateSandboxCreateResponse.md --- > 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: ApiTranslateSandboxCreateResponse Defined in: [extensions/translate.ts:500](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L500) Response of `action=translatesandbox` with `do=create` (registers a sandboxed translator; requires `$wgTranslateUseSandbox`). The `delete` / `promote` / `remind` variants return no payload — an empty [ApiEnvelope](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### translatesandbox > **translatesandbox**: `object` Defined in: [extensions/translate.ts:501](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L501) #### user > **user**: `object` The registered sandbox user. ##### user.id > **id**: `number` User id of the sandbox user. ##### user.name > **name**: `string` User name of the sandbox user. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateStatsRow.md --- > 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: ApiTranslateStatsRow Defined in: [extensions/translate.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L128) The four completeness counters shared by `meta=languagestats` and `meta=messagegroupstats` rows. A row appears only once its statistics are available; while they are still being computed the result is a continue instead. ## Extended by - [`ApiLanguageStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiLanguageStatsRow.md) - [`ApiMessageGroupStatsRow`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiMessageGroupStatsRow.md) ## Properties ### fuzzy > **fuzzy**: `number` Defined in: [extensions/translate.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L136) Number of out-of-date (fuzzy) translations. *** ### proofread > **proofread**: `number` Defined in: [extensions/translate.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L139) Number of proofread translations. *** ### total > **total**: `number` Defined in: [extensions/translate.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L130) Total number of messages. *** ### translated > **translated**: `number` Defined in: [extensions/translate.ts:133](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L133) Number of translated (non-fuzzy) messages. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslateWorkflowState.md --- > 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: ApiTranslateWorkflowState Defined in: [extensions/translate.ts:111](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L111) One workflow state of a message group (`meta=messagegroups` + `mgprop=workflowstates`). ## Indexable > \[`key`: `string`]: `unknown` Site-defined state configuration, passed through. ## Properties ### canchange? > `optional` **canchange?**: `1` Defined in: [extensions/translate.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L116) The requesting user may set this state. *** ### name > **name**: `string` Defined in: [extensions/translate.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L113) Localized state name. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md --- > 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: ApiTranslationAid Defined in: [extensions/translate.ts:256](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L256) Payload of one translation aid of `action=translationaids`, keyed by aid type (the registry is hook-extensible, so the set is open). An aid that cannot run reports [ApiTranslationAid.error](#error) instead of its data. ## Indexable > \[`key`: `string`]: `unknown` ## Properties ### error? > `optional` **error?**: `string` Defined in: [extensions/translate.ts:267](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L267) Rendered reason why this aid is unavailable. *** ### fuzzy? > `optional` **fuzzy?**: `boolean` Defined in: [extensions/translate.ts:264](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L264) Whether the translation is marked out-of-date (fuzzy). *** ### language? > `optional` **language?**: `string` Defined in: [extensions/translate.ts:258](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L258) Language of [ApiTranslationAid.value](#value), when language-bound. *** ### value? > `optional` **value?**: `string` | `null` Defined in: [extensions/translate.ts:261](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L261) The aid's payload, when it is a text value. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsPayload.md --- > 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: ApiTranslationAidsPayload Defined in: [extensions/translate.ts:278](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L278) The `helpers` map of `action=translationaids`. Members are the aid types of the [TranslationAids registry](https://www.mediawiki.org/wiki/Manual:Hooks/TranslationAids) — the built-in ones are declared here for autocomplete, the index signature keeps hook-registered aids usable. ## Indexable > \[`key`: `string`]: `unknown`\[] | [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) | `undefined` ## Properties ### definition? > `optional` **definition?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:280](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L280) Source-language definition of the message. *** ### definitiondiff? > `optional` **definitiondiff?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:292](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L292) Diff of the definition since the translation was made. *** ### documentation? > `optional` **documentation?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:286](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L286) `{{Documentation}}` subpage content; `error` when docs are disabled. *** ### editsummaries? > `optional` **editsummaries?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:295](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L295) Edit summaries of the definition page. *** ### gettext? > `optional` **gettext?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:298](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L298) Gettext metadata for gettext-defined messages. *** ### inotherlanguages? > `optional` **inotherlanguages?**: `unknown`\[] Defined in: [extensions/translate.ts:289](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L289) Existing translations in other languages; a list. *** ### insertables? > `optional` **insertables?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:301](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L301) Insertable wikitext snippets (customizable via hooks). *** ### mt? > `optional` **mt?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:304](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L304) Machine-translation suggestions, when a service is configured. *** ### support? > `optional` **support?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:307](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L307) Human translation support (e.g. TTMServer suggestions). *** ### translation? > `optional` **translation?**: [`ApiTranslationAid`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAid.md) Defined in: [extensions/translate.ts:283](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L283) The current translation in the target language. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsResponse.md --- > 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: ApiTranslationAidsResponse Defined in: [extensions/translate.ts:313](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L313) Response of `action=translationaids` (root-level `helpers` and `times`). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### helpers? > `optional` **helpers?**: [`ApiTranslationAidsPayload`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationAidsPayload.md) Defined in: [extensions/translate.ts:315](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L315) Requested aids keyed by aid type. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### times? > `optional` **times?**: `Record`\<`string`, `number`> Defined in: [extensions/translate.ts:318](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L318) Wall-clock seconds spent per aid (plus `query_aggregator`). *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchGroup.md --- > 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: ApiTranslationEntitySearchGroup Defined in: [extensions/translate.ts:472](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L472) One message group match of `action=translationentitysearch`. ## Properties ### group > **group**: `string` Defined in: [extensions/translate.ts:477](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L477) Message group id. *** ### label > **label**: `string` Defined in: [extensions/translate.ts:474](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L474) Localized group label. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchMessage.md --- > 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: ApiTranslationEntitySearchMessage Defined in: [extensions/translate.ts:481](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L481) One message prefix match of `action=translationentitysearch`. ## Properties ### count > **count**: `number` Defined in: [extensions/translate.ts:486](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L486) Number of messages matching the pattern. *** ### pattern > **pattern**: `string` Defined in: [extensions/translate.ts:483](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L483) Message key prefix; `*` marks a wildcard. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResponse.md --- > 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: ApiTranslationEntitySearchResponse Defined in: [extensions/translate.ts:490](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L490) Response of `action=translationentitysearch`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### translationentitysearch > **translationentitysearch**: [`ApiTranslationEntitySearchResult`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResult.md) Defined in: [extensions/translate.ts:492](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L492) Result of `action=translationentitysearch`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchResult.md --- > 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: ApiTranslationEntitySearchResult Defined in: [extensions/translate.ts:460](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L460) Result of `action=translationentitysearch`: message group and message key prefixes matching the query. Keys are absent when the entity type was not requested or nothing matched. ## Properties ### groups? > `optional` **groups?**: [`ApiTranslationEntitySearchGroup`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchGroup.md)\[] Defined in: [extensions/translate.ts:462](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L462) Matching message groups, best match first. *** ### messages? > `optional` **messages?**: [`ApiTranslationEntitySearchMessage`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationEntitySearchMessage.md)\[] Defined in: [extensions/translate.ts:468](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L468) Matching message key prefixes; several messages under one prefix are collapsed into a `*` wildcard pattern with a match count. --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationReviewResponse.md --- > 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: ApiTranslationReviewResponse Defined in: [extensions/translate.ts:388](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L388) Result of `action=translationreview` (CSRF-token POST, `translate-messagereview` right): one translation revision was marked as reviewed. Reviewing one's own translation, fuzzy translations and already reviewed revisions are errors / warnings. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### translationreview > **translationreview**: `object` Defined in: [extensions/translate.ts:389](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L389) #### review > **review**: `object` Result of `action=translationreview`. ##### review\.pageid > **pageid**: `number` Page id of the translation subpage. ##### review\.revision > **revision**: `number` Reviewed revision id. ##### review\.title > **title**: `string` Title of the reviewed translation, e.g. `Translations:Page/1/de`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStashResponse.md --- > 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: ApiTranslationStashResponse Defined in: [extensions/translate.ts:542](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L542) Response of `action=translationstash` (CSRF-token POST): `subaction=add` returns only the marker, `subaction=query` additionally lists the stashed translations of the requesting (sandbox) user. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### translationstash > **translationstash**: `object` Defined in: [extensions/translate.ts:543](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L543) #### result > **result**: `"ok"` Fixed `ok` marker; failures are standard top-level errors. #### translations? > `optional` **translations?**: [`ApiStashedTranslation`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiStashedTranslation.md)\[] Stashed translations, oldest first. Only with `subaction=query`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTranslationStatsResponse.md --- > 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: ApiTranslationStatsResponse Defined in: [extensions/translate.ts:322](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L322) Response of `action=translationstats`: graph data for the requested series. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### translationstats > **translationstats**: `object` Defined in: [extensions/translate.ts:323](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L323) #### data > **data**: `Record`\<`string`, `number`\[]> Per-day (per scale unit) values, one entry per series. #### labels > **labels**: `string`\[] One label per series, e.g. `Example @ Deutsch (de)`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerResponse.md --- > 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: ApiTtmServerResponse Defined in: [extensions/translate.ts:355](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L355) Response of `action=ttmserver`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### ttmserver > **ttmserver**: [`ApiTtmServerSuggestion`](https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerSuggestion.md)\[] Defined in: [extensions/translate.ts:357](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L357) Suggestions, best match first; `[]` when the memory has no hit. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/translate/ApiTtmServerSuggestion.md --- > 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: ApiTtmServerSuggestion Defined in: [extensions/translate.ts:337](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L337) One suggestion of `action=ttmserver`: a translation-memory hit for the requested text. The fields are supplied by the configured translation-memory service; a unit from the local memory carries the fields below. ## Properties ### context > **context**: `string` Defined in: [extensions/translate.ts:345](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L345) Message key of the stored unit, e.g. `Translations:Example/1`. *** ### location > **location**: `string` Defined in: [extensions/translate.ts:348](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L348) Canonical URL of the translation page the unit came from. *** ### quality > **quality**: `number` Defined in: [extensions/translate.ts:351](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L351) Match quality as a ratio between 0 and 1 (1 is a perfect match). *** ### source > **source**: `string` Defined in: [extensions/translate.ts:339](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L339) Source text of the stored translation unit. *** ### target > **target**: `string` Defined in: [extensions/translate.ts:342](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/translate.ts#L342) Translation text of the stored unit. --- url: https://types-mediawiki-response.pages.dev/api/extensions/uls/overview.md --- > 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. # Universal Language Selector ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiUlsLocalizationMetadata](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsLocalizationMetadata.md) | Metadata block of a ULS localization bundle, carried over from the source i18n files. Only the keys the wiki's ULS files actually use appear. | | [ApiUlsLocalizationResponse](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsLocalizationResponse.md) | Response of `action=ulslocalization`: the ULS message bundle for one language (its fallback chain merged in), returned raw as JSON — there is no envelope and no `ulslocalization` wrapper. Keys are ULS message ids (e.g. `uls-region-WW`) mapped to their translation; `@metadata` holds the source file credits. The module is internal to ULS; responses are cached publicly for 28 days. | | [ApiUlsSetLanguageResponse](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsSetLanguageResponse.md) | Response of `action=ulssetlang` (CSRF-token POST): stores the interface language in the named user's preferences. A success response carries no payload keys. Anonymous callers only succeed when `$wgULSAnonCanChangeLanguage` is enabled (then only a cookie is set, likewise with no payload). | --- url: https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsLocalizationMetadata.md --- > 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: ApiUlsLocalizationMetadata Defined in: [extensions/uls.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/uls.ts#L35) Metadata block of a ULS localization bundle, carried over from the source i18n files. Only the keys the wiki's ULS files actually use appear. ## Properties ### authors? > `optional` **authors?**: `string`\[] Defined in: [extensions/uls.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/uls.ts#L37) translators: credited in the source file. *** ### message-documentation? > `optional` **message-documentation?**: `string` Defined in: [extensions/uls.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/uls.ts#L40) Message documentation language code, typically `qqq`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsLocalizationResponse.md --- > 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: ApiUlsLocalizationResponse Defined in: [extensions/uls.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/uls.ts#L51) Response of `action=ulslocalization`: the ULS message bundle for one language (its fallback chain merged in), returned raw as JSON — there is no envelope and no `ulslocalization` wrapper. Keys are ULS message ids (e.g. `uls-region-WW`) mapped to their translation; `@metadata` holds the source file credits. The module is internal to ULS; responses are cached publicly for 28 days. ## Indexable > \[`key`: `string`]: `string` | [`ApiUlsLocalizationMetadata`](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsLocalizationMetadata.md) | `undefined` ## Properties ### @metadata? > `optional` **@metadata?**: [`ApiUlsLocalizationMetadata`](https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsLocalizationMetadata.md) Defined in: [extensions/uls.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/uls.ts#L53) Credits and provenance of the merged source files. --- url: https://types-mediawiki-response.pages.dev/api/extensions/uls/ApiUlsSetLanguageResponse.md --- > 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: ApiUlsSetLanguageResponse Defined in: [extensions/uls.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/uls.ts#L29) Response of `action=ulssetlang` (CSRF-token POST): stores the interface language in the named user's preferences. A success response carries no payload keys. Anonymous callers only succeed when `$wgULSAnonCanChangeLanguage` is enabled (then only a cookie is set, likewise with no payload). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/overview.md --- > 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. # UrlShortener ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | | [ApiShortenUrlResponse](https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResponse.md) | Response of `action=shortenurl`. | | [ApiShortenUrlResult](https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResult.md) | The `shortenurl` object of an `action=shortenurl` response. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResponse.md --- > 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: ApiShortenUrlResponse Defined in: [extensions/urlshortener.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/urlshortener.ts#L44) Response of `action=shortenurl`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### shortenurl > **shortenurl**: [`ApiShortenUrlResult`](https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResult.md) Defined in: [extensions/urlshortener.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/urlshortener.ts#L46) Result of `action=shortenurl`. *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/urlshortener/ApiShortenUrlResult.md --- > 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: ApiShortenUrlResult Defined in: [extensions/urlshortener.ts:24](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/urlshortener.ts#L24) The `shortenurl` object of an `action=shortenurl` response. ## Properties ### qrcode? > `optional` **qrcode?**: `string` Defined in: [extensions/urlshortener.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/urlshortener.ts#L40) SVG markup of a QR code encoding the target URL, when `qrcode=1` was passed and the wiki has QR codes enabled. #### Since MediaWiki 1.41 *** ### shorturl? > `optional` **shorturl?**: `string` Defined in: [extensions/urlshortener.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/urlshortener.ts#L26) Full short URL carrying the base-32 short code. *** ### shorturlalt? > `optional` **shorturlalt?**: `string` Defined in: [extensions/urlshortener.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/urlshortener.ts#L32) Alternative short URL using the alternate code mapping (a string whose characters are individually base-32-shifted), kept valid in parallel. --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/overview.md --- > 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. # VisualEditor ## Interfaces | Interface | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ApiEditCheckReferenceUrlResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiEditCheckReferenceUrlResponse.md) | Response of `action=editcheckreferenceurl`: the verdict for the checked URL — `"allowed"` or `"blocked"`. Always exactly one entry, keyed by the requested URL. | | [ApiLastModified](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiLastModified.md) | `lastModified` display parts of the edited page, as emitted by `action=visualeditor`/`visualeditoredit` and by DiscussionTools' `discussiontoolsedit` (both render the same last-modified widget data). | | [ApiVisualEditorCheckboxDef](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorCheckboxDef.md) | One field of the edit form (`checkboxesDef.wpMinoredit`, `wpWatchthis`, `wpWatchlistExpiry`). | | [ApiVisualEditorEditResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorEditResponse.md) | Response of `action=visualeditoredit`. | | [ApiVisualEditorPageFrame](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorPageFrame.md) | The page frame both `visualeditor` and `visualeditoredit` return. | | [ApiVisualEditorParseFragmentResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorParseFragmentResponse.md) | Response of `action=visualeditor` with `paction=parsefragment`: just the transformed fragment and the outcome flag. | | [ApiVisualEditorResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorResponse.md) | Response of `action=visualeditor` for `paction=parse`, `wikitext` and `metadata`, which share one payload. The other `paction` values return different shapes — see [ApiVisualEditorTemplatesUsedResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorTemplatesUsedResponse.md) and [ApiVisualEditorParseFragmentResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorParseFragmentResponse.md). | | [ApiVisualEditorTemplatesUsedResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorTemplatesUsedResponse.md) | Response of `action=visualeditor` with `paction=templatesused`, where the module writes an HTML string instead of the usual object. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiEditCheckReferenceUrlResponse.md --- > 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: ApiEditCheckReferenceUrlResponse Defined in: [extensions/visualeditor.ts:269](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L269) Response of `action=editcheckreferenceurl`: the verdict for the checked URL — `"allowed"` or `"blocked"`. Always exactly one entry, keyed by the requested URL. ## Since MediaWiki 1.42 ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### editcheckreferenceurl > **editcheckreferenceurl**: `Record`\<`string`, `"allowed"` | `"blocked"` | `string` & `object`> Defined in: [extensions/visualeditor.ts:271](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L271) Verdict per checked URL, keyed by the requested URL; exactly one entry. *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiLastModified.md --- > 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: ApiLastModified Defined in: [extensions/visualeditor.ts:92](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L92) `lastModified` display parts of the edited page, as emitted by `action=visualeditor`/`visualeditoredit` and by DiscussionTools' `discussiontoolsedit` (both render the same last-modified widget data). ## Properties ### date? > `optional` **date?**: `string` Defined in: [extensions/visualeditor.ts:94](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L94) Localized date, e.g. `15 January 2024`. *** ### message? > `optional` **message?**: `string` Defined in: [extensions/visualeditor.ts:100](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L100) Full sentence combining both. *** ### time? > `optional` **time?**: `string` Defined in: [extensions/visualeditor.ts:97](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L97) Localized time, e.g. `18:34`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorCheckboxDef.md --- > 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: ApiVisualEditorCheckboxDef Defined in: [extensions/visualeditor.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L43) One field of the edit form (`checkboxesDef.wpMinoredit`, `wpWatchthis`, `wpWatchlistExpiry`). ## Properties ### class? > `optional` **class?**: `string` Defined in: [extensions/visualeditor.ts:63](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L63) PHP class of the OOUI widget; set for the `wpWatchlistExpiry` dropdown. *** ### default? > `optional` **default?**: `string` | `boolean` Defined in: [extensions/visualeditor.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L84) Whether the box starts checked — or the preselected expiry string for the `wpWatchlistExpiry` dropdown. A real `boolean` under fv2 for checkboxes. *** ### id? > `optional` **id?**: `string` Defined in: [extensions/visualeditor.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L45) Element id, e.g. `wpMinoredit`. *** ### invisibleLabel? > `optional` **invisibleLabel?**: `true` Defined in: [extensions/visualeditor.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L78) Label rendered invisibly (`wpWatchlistExpiry` only). *** ### label-id? > `optional` **label-id?**: `string` Defined in: [extensions/visualeditor.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L54) DOM id of the labelled element. *** ### label-message? > `optional` **label-message?**: `string` Defined in: [extensions/visualeditor.ts:48](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L48) Message key holding the label. *** ### legacy-name? > `optional` **legacy-name?**: `string` Defined in: [extensions/visualeditor.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L57) Legacy form field name. *** ### options? > `optional` **options?**: `object`\[] Defined in: [extensions/visualeditor.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L66) Dropdown options as label/value pairs (`wpWatchlistExpiry` only). #### data? > `optional` **data?**: `string` Value submitted when the option is chosen. #### label? > `optional` **label?**: `string` Option text shown in the dropdown. *** ### title-message? > `optional` **title-message?**: `string` Defined in: [extensions/visualeditor.ts:51](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L51) Message key for the label's `title` attribute; hook-provided checkboxes only. *** ### tooltip? > `optional` **tooltip?**: `string` Defined in: [extensions/visualeditor.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L60) Access-key/tooltip message slug, e.g. `minoredit`. *** ### value-attr? > `optional` **value-attr?**: `string` Defined in: [extensions/visualeditor.ts:75](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L75) Widget config option carrying the current value (`wpWatchlistExpiry` only). --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorEditResponse.md --- > 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: ApiVisualEditorEditResponse Defined in: [extensions/visualeditor.ts:257](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L257) Response of `action=visualeditoredit`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### visualeditoredit > **visualeditoredit**: [`ApiVisualEditorPageFrame`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorPageFrame.md) Defined in: [extensions/visualeditor.ts:259](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L259) Result of `action=visualeditoredit`. *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorPageFrame.md --- > 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: ApiVisualEditorPageFrame Defined in: [extensions/visualeditor.ts:104](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L104) The page frame both `visualeditor` and `visualeditoredit` return. ## Properties ### cachekey? > `optional` **cachekey?**: `string` Defined in: [extensions/visualeditor.ts:154](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L154) Key into the serialisation cache, from `visualeditoredit` `paction=serializeforcache`. *** ### categorieshtml? > `optional` **categorieshtml?**: `string` Defined in: [extensions/visualeditor.ts:121](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L121) Category bar HTML. *** ### content? > `optional` **content?**: `string` Defined in: [extensions/visualeditor.ts:109](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L109) Rendered page body (HTML for `parse`, wikitext for `wikitext`). *** ### contentSub? > `optional` **contentSub?**: `string` Defined in: [extensions/visualeditor.ts:115](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L115) Page subtitle ("Revision as of …") HTML. *** ### diff? > `optional` **diff?**: `string` Defined in: [extensions/visualeditor.ts:151](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L151) HTML diff, from `visualeditoredit` `paction=diff`. *** ### displayTitleHtml? > `optional` **displayTitleHtml?**: `string` Defined in: [extensions/visualeditor.ts:118](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L118) Display title HTML. *** ### edit? > `optional` **edit?**: [`ApiEditResult`](https://types-mediawiki-response.pages.dev/api/core/ApiEditResult.md) Defined in: [extensions/visualeditor.ts:160](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L160) The underlying `action=edit` result, on the save failure branch (`result: "error"`). *** ### isRedirect? > `optional` **isRedirect?**: `string` Defined in: [extensions/visualeditor.ts:136](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L136) Empty string for a normal page — this is the legacy empty-string flag pattern rather than a boolean. *** ### jsconfigvars? > `optional` **jsconfigvars?**: `Record`\<`string`, `unknown`> Defined in: [extensions/visualeditor.ts:130](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L130) ResourceLoader config variables (e.g. `wgEchoSeenTime`). *** ### lastModified? > `optional` **lastModified?**: [`ApiLastModified`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiLastModified.md) Defined in: [extensions/visualeditor.ts:139](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L139) When the page last changed, in display parts. *** ### modules? > `optional` **modules?**: `string`\[] Defined in: [extensions/visualeditor.ts:127](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L127) ResourceLoader modules the response needs. *** ### newrevid? > `optional` **newrevid?**: `number` Defined in: [extensions/visualeditor.ts:142](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L142) New revision id, from `visualeditoredit` `paction=save`. *** ### nocontent? > `optional` **nocontent?**: `true` Defined in: [extensions/visualeditor.ts:157](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L157) `true` when the save asked to skip the re-render (`nocontent` parameter), so no `content` follows. *** ### preloaded? > `optional` **preloaded?**: `boolean` Defined in: [extensions/visualeditor.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L112) Whether [content](#content) came from a preload rather than the page. *** ### result? > `optional` **result?**: `"error"` | `"success"` Defined in: [extensions/visualeditor.ts:106](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L106) Outcome of the request; `error` on the save-failure branch. *** ### sections? > `optional` **sections?**: `unknown`\[] Defined in: [extensions/visualeditor.ts:124](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L124) Section index of the edited/loaded page. *** ### tempusercreated? > `optional` **tempusercreated?**: `true` Defined in: [extensions/visualeditor.ts:163](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L163) `true` when a temporary account was created by this edit. *** ### tempusercreatedredirect? > `optional` **tempusercreatedredirect?**: `string` Defined in: [extensions/visualeditor.ts:166](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L166) Redirect URL for a just-created temporary account, when one applies. *** ### watched? > `optional` **watched?**: `boolean` Defined in: [extensions/visualeditor.ts:145](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L145) Whether the editor watches the page now. *** ### watchlistexpiry? > `optional` **watchlistexpiry?**: [`WatchlistExpiry`](https://types-mediawiki-response.pages.dev/api/core/WatchlistExpiry.md) Defined in: [extensions/visualeditor.ts:148](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L148) When that watch expires; `null` when permanent. --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorParseFragmentResponse.md --- > 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: ApiVisualEditorParseFragmentResponse Defined in: [extensions/visualeditor.ts:243](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L243) Response of `action=visualeditor` with `paction=parsefragment`: just the transformed fragment and the outcome flag. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### visualeditor > **visualeditor**: `object` Defined in: [extensions/visualeditor.ts:245](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L245) Result of `action=visualeditor&paction=parsefragment`. #### content > **content**: `string` Transformed wikitext fragment. #### result > **result**: `"success"` Success sentinel; a rejected call comes back as a top-level error. *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorResponse.md --- > 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: ApiVisualEditorResponse Defined in: [extensions/visualeditor.ts:175](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L175) Response of `action=visualeditor` for `paction=parse`, `wikitext` and `metadata`, which share one payload. The other `paction` values return different shapes — see [ApiVisualEditorTemplatesUsedResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorTemplatesUsedResponse.md) and [ApiVisualEditorParseFragmentResponse](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorParseFragmentResponse.md). ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### visualeditor > **visualeditor**: [`ApiVisualEditorPageFrame`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorPageFrame.md) & `object` Defined in: [extensions/visualeditor.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L177) Result of `action=visualeditor` for the `paction` values sharing this payload. #### Type Declaration ##### basetimestamp > **basetimestamp**: `string` Base timestamp for edit-conflict detection. ##### blockinfo > **blockinfo**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/api/core/ApiBlockInfo.md) | `null` Block state of the requesting user; `null` when not blocked. ##### canEdit > **canEdit**: `boolean` Whether the user may edit this page at all. ##### checkboxesDef > **checkboxesDef**: `unknown`\[] | `Record`\<`string`, [`ApiVisualEditorCheckboxDef`](https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorCheckboxDef.md)> Definitions of the save-form fields, keyed by element id. An empty PHP map, so `[]` when no field applies to the requesting user. ##### checkboxesMessages > **checkboxesMessages**: `unknown`\[] | `Record`\<`string`, `string`> Plain text of the messages referenced by `checkboxesDef`. An empty PHP map, so `[]` when there are no messages. ##### copyrightWarning > **copyrightWarning**: `string` Copyright warning HTML; `""` when none applies. ##### etag? > `optional` **etag?**: `string` Restbase/Parsoid ETag for conditional requests. ##### notices > **notices**: `unknown`\[] | `Record`\<`string`, `string`> Notices the editor should show above the form, keyed by message name (e.g. `newarticletext` for a page that does not exist yet). An empty PHP map, so `[]` when there is nothing to show. ##### oldid > **oldid**: `number` Revision id the content was taken from. ##### protectedClasses > **protectedClasses**: `string` CSS classes for protection state, joined into one string (`""` when none). ##### starttimestamp > **starttimestamp**: `string` Server timestamp when the request started. ##### wouldautocreate? > `optional` **wouldautocreate?**: `boolean` Whether an auto-created temporary account would be used for the edit. ###### Since MediaWiki 1.41 *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorTemplatesUsedResponse.md --- > 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: ApiVisualEditorTemplatesUsedResponse Defined in: [extensions/visualeditor.ts:234](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L234) Response of `action=visualeditor` with `paction=templatesused`, where the module writes an HTML string instead of the usual object. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### visualeditor > **visualeditor**: `string` Defined in: [extensions/visualeditor.ts:236](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/visualeditor.ts#L236) HTML string written by `paction=templatesused`, in place of the usual object. *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/overview.md --- > 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. # Wikibase ## Interfaces | Interface | Description | | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | [ApiEntityUsage](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsage.md) | A single entity's usage record: which aspects were used, and an optional repo link. | | [ApiEntityUsageRow](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageRow.md) | One row of `list=wblistentityusage` (a local page using the queried entity). | | [ApiPageTerms](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiPageTerms.md) | Terms of the entity linked to a page (`prop=pageterms`). | | [ApiWikibaseInfo](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseInfo.md) | The `wikibase` object of a `meta=wikibase` response. | | [ApiWikibaseRepo](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseRepo.md) | The `repo` object of `meta=wikibase`. | | [ApiWikibaseRepoUrl](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseRepoUrl.md) | Repo location info (`meta=wikibase`, `wbprop=url`). | ## Type Aliases | Type Alias | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | | [ApiEntityUsageMap](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageMap.md) | Entity id → usage. Each row carries at least one entity; an empty map does not occur. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsage.md --- > 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: ApiEntityUsage Defined in: [extensions/wikibase.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L37) A single entity's usage record: which aspects were used, and an optional repo link. ## Properties ### aspects? > `optional` **aspects?**: `string`\[] Defined in: [extensions/wikibase.ts:42](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L42) Usage aspects, as opaque codes — often compound (`"CQR"` = statements + qualifiers + references, `"D.en"` = English description). Open string list. *** ### url? > `optional` **url?**: `string` Defined in: [extensions/wikibase.ts:45](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L45) Link to the entity page on the repo. Only with `wbeuprop=url` / `wbleuprop=url`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageMap.md --- > 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. # Type Alias: ApiEntityUsageMap > **ApiEntityUsageMap** = `Record`\<`string`, [`ApiEntityUsage`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsage.md)> Defined in: [extensions/wikibase.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L49) Entity id → usage. Each row carries at least one entity; an empty map does not occur. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageRow.md --- > 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: ApiEntityUsageRow Defined in: [extensions/wikibase.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L91) One row of `list=wblistentityusage` (a local page using the queried entity). ## Properties ### ns? > `optional` **ns?**: `number` Defined in: [extensions/wikibase.ts:93](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L93) Namespace index. *** ### pageid? > `optional` **pageid?**: `number` Defined in: [extensions/wikibase.ts:99](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L99) Local page id. *** ### title? > `optional` **title?**: `string` Defined in: [extensions/wikibase.ts:96](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L96) Page title, prefixed for non-main namespaces. *** ### wblistentityusage? > `optional` **wblistentityusage?**: [`ApiEntityUsageMap`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiEntityUsageMap.md) Defined in: [extensions/wikibase.ts:102](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L102) Entities used by this page and their usage (the queried entities). --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiPageTerms.md --- > 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: ApiPageTerms Defined in: [extensions/wikibase.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L52) Terms of the entity linked to a page (`prop=pageterms`). ## Properties ### alias? > `optional` **alias?**: `string`\[] Defined in: [extensions/wikibase.ts:60](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L60) Alias(es) in the requested language. *** ### description? > `optional` **description?**: `string`\[] Defined in: [extensions/wikibase.ts:57](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L57) Description(s) in the requested language. *** ### label? > `optional` **label?**: `string`\[] Defined in: [extensions/wikibase.ts:54](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L54) Label(s) in the requested language. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseInfo.md --- > 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: ApiWikibaseInfo Defined in: [extensions/wikibase.ts:82](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L82) The `wikibase` object of a `meta=wikibase` response. ## Properties ### repo? > `optional` **repo?**: [`ApiWikibaseRepo`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseRepo.md) Defined in: [extensions/wikibase.ts:84](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L84) Repo URL info. `wbprop=url`. *** ### siteid? > `optional` **siteid?**: `string` Defined in: [extensions/wikibase.ts:87](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L87) This wiki's global site id, e.g. `mediawikiwiki`. `wbprop=siteid`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseRepo.md --- > 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: ApiWikibaseRepo Defined in: [extensions/wikibase.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L76) The `repo` object of `meta=wikibase`. ## Properties ### url? > `optional` **url?**: [`ApiWikibaseRepoUrl`](https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseRepoUrl.md) Defined in: [extensions/wikibase.ts:78](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L78) Repo addresses, as `base`/`scriptpath`/`articlepath`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikibase/ApiWikibaseRepoUrl.md --- > 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: ApiWikibaseRepoUrl Defined in: [extensions/wikibase.ts:64](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L64) Repo location info (`meta=wikibase`, `wbprop=url`). ## Properties ### articlepath? > `optional` **articlepath?**: `string` Defined in: [extensions/wikibase.ts:72](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L72) Repo article path with the `$1` placeholder. *** ### base? > `optional` **base?**: `string` Defined in: [extensions/wikibase.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L66) Repo base URL. *** ### scriptpath? > `optional` **scriptpath?**: `string` Defined in: [extensions/wikibase.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikibase.ts#L69) Repo script path, e.g. `/w`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikilove/overview.md --- > 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. # WikiLove ## Interfaces | Interface | Description | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | [ApiWikiLoveRedirect](https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveRedirect.md) | The `redirect` object of an `action=wikilove` response. | | [ApiWikiLoveResponse](https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveResponse.md) | Response of `action=wikilove`. | --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveRedirect.md --- > 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: ApiWikiLoveRedirect Defined in: [extensions/wikilove.ts:27](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikilove.ts#L27) The `redirect` object of an `action=wikilove` response. ## Properties ### fragment > **fragment**: `string` Defined in: [extensions/wikilove.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikilove.ts#L35) Section anchor built from the sanitized subject: whitespace becomes `_` and a `%XX` escape becomes `%25XX`. *** ### pageName > **pageName**: `string` Defined in: [extensions/wikilove.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikilove.ts#L29) DB key of the talk page the message was posted to, e.g. `User_talk:Example`. --- url: https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveResponse.md --- > 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: ApiWikiLoveResponse Defined in: [extensions/wikilove.ts:39](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikilove.ts#L39) Response of `action=wikilove`. ## Extends - [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md) ## Properties ### batchcomplete? > `optional` **batchcomplete?**: `true` Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178) Present and `true` when all data for the current batch of pages has been returned. Continuation may still be ongoing: the generator runs again for the next batch of pages, and list/meta modules may continue independently. Serialized as a real boolean under `formatversion=2`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete) *** ### curtimestamp? > `optional` **curtimestamp?**: `string` Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187) Current server time (ISO 8601), present when the request set `curtimestamp`. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp) *** ### errorlang? > `optional` **errorlang?**: `string` Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199) Language error messages are rendered in (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang) *** ### redirect > **redirect**: [`ApiWikiLoveRedirect`](https://types-mediawiki-response.pages.dev/api/extensions/wikilove/ApiWikiLoveRedirect.md) Defined in: [extensions/wikilove.ts:41](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/extensions/wikilove.ts#L41) Result of `action=wikilove`; this module keys its payload `redirect`. *** ### requestid? > `optional` **requestid?**: `string` Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190) Opaque value echoed back from the request's `requestid` parameter. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid) *** ### servedby? > `optional` **servedby?**: `string` Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184) Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested. #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby) *** ### uselang? > `optional` **uselang?**: `string` Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196) Language of the interface strings in the response (`responselanginfo=1`). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang) *** ### warnings? > `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md) Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193) Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)). #### Inherited from [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings) --- url: https://types-mediawiki-response.pages.dev/index.md --- > 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. # types-mediawiki-response > TypeScript types for MediaWiki Action API responses [Getting started](/guide/getting-started) | [API reference](/api/) ## Features - <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M21 16V8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73l7 4a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16z"/><polyline points="3.27 6.96 12 12.01 20.73 6.96"/><line x1="12" y1="22.08" x2="12" y2="12"/></svg> **Pure types, zero runtime**: Type declarations only — no impact on your bundle size. - <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z"/><path d="m9 12 2 2 4-4"/></svg> **Cross-version coverage**: One field union across MediaWiki 1.39–1.47. - <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m18 16 4-4-4-4"/><path d="m6 8-4 4 4 4"/><path d="m14.5 4-5 16"/></svg> **Full JSDoc coverage**: Every field is annotated with its parameter and semantics; hover in your IDE and it is there. - <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12.83 2.18a2 2 0 0 0-1.66 0L2.6 6.08a1 1 0 0 0 0 1.83l8.58 3.91a2 2 0 0 0 1.66 0l8.58-3.9a1 1 0 0 0 0-1.83Z"/><path d="m22 17.65-9.17 4.16a2 2 0 0 1-1.66 0L2 17.65"/><path d="m22 12.65-9.17 4.16a2 2 0 0 1-1.66 0L2 12.65"/></svg> **Bundled extensions, opt-in**: Response types for common extensions — one import activates a pack.