> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/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/zh/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/zh/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEnvelope.md#batchcomplete)

***

### converted?

> `optional` **converted?**: [`ApiQueryTitlePair`](https://types-mediawiki-response.pages.dev/zh/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/zh/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/zh/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/zh/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEnvelope.md#errorlang)

***

### normalized?

> `optional` **normalized?**: [`ApiQueryNormalized`](https://types-mediawiki-response.pages.dev/zh/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/zh/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/zh/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/zh/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/zh/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/zh/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/zh/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/zh/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEnvelope.md#uselang)

***

### warnings?

> `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/zh/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/zh/api/core/ApiWarnings.md)).

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiEnvelope.md#warnings)
