#Interface: ApiCompareResult

Defined in: core/compare.ts:15

The compare object of a successful action=compare response.

#Properties

#bodies?

optional bodies?: Record<string, string>

Defined in: core/compare.ts:23

Per-slot diff bodies, keyed by slot role. prop=diff when comparing specific slots (fromslots/toslots); takes the place of body.

---

#body?

optional body?: string

Defined in: core/compare.ts:17

Diff HTML. prop=diff; only when the diff is not split per slot.

---

#diffsize?

optional diffsize?: number

Defined in: core/compare.ts:26

Size of the diff HTML in bytes. prop=diffsize.

---

#fromarchive?

optional fromarchive?: true

Defined in: core/compare.ts:67

The from revision was read from the archive (deleted since it was referenced). A Flag.

---

#fromcomment?

optional fromcomment?: string

Defined in: core/compare.ts:50

Edit summary of the from revision. prop=comment.

---

#fromcommenthidden?

optional fromcommenthidden?: true

Defined in: core/compare.ts:61

The from revision's summary is hidden. A Flag.

---

#fromid?

optional fromid?: number

Defined in: core/compare.ts:34

Page id of the from side. prop=ids.

---

#fromns?

optional fromns?: number

Defined in: core/compare.ts:38

Namespace index of the from side. prop=title.

---

#fromparsedcomment?

optional fromparsedcomment?: string

Defined in: core/compare.ts:52

HTML-rendered summary of the from revision. prop=comment or prop=parsedcomment.

---

#fromrevid?

optional fromrevid?: number

Defined in: core/compare.ts:36

Revision id of the from side. prop=ids.

---

#fromsize?

optional fromsize?: number

Defined in: core/compare.ts:42

Revision size in bytes of the from side. prop=size.

---

#fromsuppressed?

optional fromsuppressed?: true

Defined in: core/compare.ts:64

Suppression (oversight) applies to the from revision, alongside the *hidden flags. A Flag.

---

#fromtexthidden?

optional fromtexthidden?: true

Defined in: core/compare.ts:55

The from revision's content is hidden (revision-deleted). A Flag.

---

#fromtimestamp?

optional fromtimestamp?: string

Defined in: core/compare.ts:44

Timestamp of the from revision. prop=timestamp.

---

#fromtitle?

optional fromtitle?: string

Defined in: core/compare.ts:40

Page title of the from side. prop=title.

---

#fromuser?

optional fromuser?: string

Defined in: core/compare.ts:46

Editor of the from revision. prop=user.

---

#fromuserhidden?

optional fromuserhidden?: true

Defined in: core/compare.ts:58

The from revision's author is hidden. A Flag.

---

#fromuserid?

optional fromuserid?: number

Defined in: core/compare.ts:48

Editor user id of the from revision. prop=user.

---

#next?

optional next?: number

Defined in: core/compare.ts:31

Revision id following the to side. prop=rel.

---

#prev?

optional prev?: number

Defined in: core/compare.ts:29

Revision id preceding the from side. prop=rel.

---

#toarchive?

optional toarchive?: true

Defined in: core/compare.ts:103

The to revision was read from the archive (deleted since it was referenced). A Flag.

---

#tocomment?

optional tocomment?: string

Defined in: core/compare.ts:86

Edit summary of the to revision. prop=comment.

---

#tocommenthidden?

optional tocommenthidden?: true

Defined in: core/compare.ts:97

The to revision's summary is hidden. A Flag.

---

#toid?

optional toid?: number

Defined in: core/compare.ts:70

Page id of the to side. prop=ids.

---

#tons?

optional tons?: number

Defined in: core/compare.ts:74

Namespace index of the to side. prop=title.

---

#toparsedcomment?

optional toparsedcomment?: string

Defined in: core/compare.ts:88

HTML-rendered summary of the to revision. prop=comment or prop=parsedcomment.

---

#torevid?

optional torevid?: number

Defined in: core/compare.ts:72

Revision id of the to side. prop=ids.

---

#tosize?

optional tosize?: number

Defined in: core/compare.ts:78

Revision size in bytes of the to side. prop=size.

---

#tosuppressed?

optional tosuppressed?: true

Defined in: core/compare.ts:100

Suppression (oversight) applies to the to revision, alongside the *hidden flags. A Flag.

---

#totexthidden?

optional totexthidden?: true

Defined in: core/compare.ts:91

The to revision's content is hidden (revision-deleted). A Flag.

---

#totimestamp?

optional totimestamp?: string

Defined in: core/compare.ts:80

Timestamp of the to revision. prop=timestamp.

---

#totitle?

optional totitle?: string

Defined in: core/compare.ts:76

Page title of the to side. prop=title.

---

#touser?

optional touser?: string

Defined in: core/compare.ts:82

Editor of the to revision. prop=user.

---

#touserhidden?

optional touserhidden?: true

Defined in: core/compare.ts:94

The to revision's author is hidden. A Flag.

---

#touserid?

optional touserid?: number

Defined in: core/compare.ts:84

Editor user id of the to revision. prop=user.