Class ContributionSurveyRow

Represents a contribution survey row. This is an abstraction of the row that can be seen on contribution survey pages, which acts as an intermediate between raw wikitext and actual HTML content.

Index

Constructors

constructor

new ContributionSurveyRow(casePage, wikitext): ContributionSurveyRow
Creates a new contribution survey row from MediaWiki parser output.
Parameters
- casePage: DeputyCasePage
  The case page of this row
- wikitext: string
  The wikitext of the row
Returns ContributionSurveyRow
- Defined in src/models/ContributionSurveyRow.ts:269

Properties

casePage

casePage: DeputyCasePage

The case page of this row.

`Optional`comment

comment?: string

Editor comments for this row (including signature)

extras

extras: string

Extra page information. e.g. "(1 edit, 1 major, +173)"

`Readonly`originalStatus

originalStatus: ContributionSurveyRowStatus

The original status of this row (if it had a prior status).

status

status: ContributionSurveyRowStatus

The status of this row.

`Optional`statusIsolated

statusIsolated?: false | "start" | "end"

Determines if the status indicator (as tested by the regular expressions at ContributionSurveyRow.commentMatchRegex) is isolated (at the start or end of the comment). This will enable removal of the status indicator from the comment in the comment text input box.

title

title: Title

The title of the page that this row is attached to.

type

type: "detailed" | "pageonly"

detailed refers to a row with both page and revision information.
pageonly refers to a row with only a page and no revision information.

wikitext

wikitext: string

The original wikitext of the row.

`Static` `Readonly`commentMatchRegex

commentMatchRegex: Record<
    | WithViolations
    | WithoutViolations
    | Missing
    | PresumptiveRemoval, RegExp> = ...

A set of regular expressions that will match a specific contribution survey row comment. Used to determine the status of the comment.

`Static` `Readonly`Parser

Parser: typeof ContributionSurveyRowParser = ContributionSurveyRowParser

Accessors

completed

get completed(): boolean
This variable returns true when (a) the row has a non-unfinished status, and (b) there are no outstanding diffs in this row

Returns boolean
See description.
- Defined in src/models/ContributionSurveyRow.ts:241

Methods

getActualComment

getActualComment(): string
Gets the comment with status indicator removed.

Returns string
The comment with the status indicator removed.
- Defined in src/models/ContributionSurveyRow.ts:376

getDiffs

getDiffs(forceReload?): Promise<Map<number, ContributionSurveyRevision>>
Get the ContributionSurveyRowRevisions of this row.
Parameters
- forceReload: boolean = false
Returns Promise<Map<number, ContributionSurveyRevision>>
- Defined in src/models/ContributionSurveyRow.ts:306

`Static`getSorterFunction

getSorterFunction(sort, mode?): ((a: ContributionSurveyRevision, b: ContributionSurveyRevision) => number)
Gets the sorter function which will sort a set of diffs based on a given sort order. This sorts any array containing revisions.
Parameters
- sort: ContributionSurveyRowSort
- Optionalmode: "array"
  The sort mode to use.
Returns ((a: ContributionSurveyRevision, b: ContributionSurveyRevision) => number)
- - (a, b): number
  - Parameters
    - a: ContributionSurveyRevision
    - b: ContributionSurveyRevision
    Returns number
- Defined in src/models/ContributionSurveyRow.ts:130
getSorterFunction(sort, mode?): ((a: [ContributionSurveyRevision, any], b: [ContributionSurveyRevision, any]) => number)
Gets the sorter function which will sort a set of diffs based on a given sort order. This sorts any entry array using the first element (the key).
Parameters
- sort: ContributionSurveyRowSort
- Optionalmode: "key"
  The sort mode to use.
Returns ((a: [ContributionSurveyRevision, any], b: [ContributionSurveyRevision, any]) => number)
- - (a, b): number
  - Parameters
    - a: [ContributionSurveyRevision, any]
    - b: [ContributionSurveyRevision, any]
    Returns number
- Defined in src/models/ContributionSurveyRow.ts:139
getSorterFunction(sort, mode?): ((a: [any, ContributionSurveyRevision], b: [any, ContributionSurveyRevision]) => number)
Gets the sorter function which will sort a set of diffs based on a given sort order. This sorts any entry array using the second element (the value).
Parameters
- sort: ContributionSurveyRowSort
- Optionalmode: "value"
  The sort mode to use.
Returns ((a: [any, ContributionSurveyRevision], b: [any, ContributionSurveyRevision]) => number)
- - (a, b): number
  - Parameters
    - a: [any, ContributionSurveyRevision]
    - b: [any, ContributionSurveyRevision]
    Returns number
- Defined in src/models/ContributionSurveyRow.ts:148

`Static`guessSortOrder

guessSortOrder(diffs): ContributionSurveyRowSort
Guesses the sort order for a given set of revisions.
Parameters
- diffs: Iterable<ContributionSurveyRevision>
  The diffs to guess from.
Returns ContributionSurveyRowSort
The sort order
- Defined in src/models/ContributionSurveyRow.ts:65

`Static`identifyCommentStatus

identifyCommentStatus(comment):
    | Unknown
    | WithViolations
    | WithoutViolations
    | Missing
    | PresumptiveRemoval
Identifies a row's current status based on the comment's contents.
Parameters
- comment: string
  The comment to process
Returns
    | Unknown
    | WithViolations
    | WithoutViolations
    | Missing
    | PresumptiveRemoval
The status of the row
- Defined in src/models/ContributionSurveyRow.ts:45

Class ContributionSurveyRow

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ContributionSurveyRow

Properties

casePage

Optionalcomment

extras

ReadonlyoriginalStatus

status

OptionalstatusIsolated

title

type

wikitext

Static ReadonlycommentMatchRegex

Static ReadonlyParser

Accessors

completed

Returns boolean

Methods

getActualComment

Returns string

getDiffs

Parameters

Returns Promise<Map<number, ContributionSurveyRevision>>

StaticgetSorterFunction

Parameters

Returns ((a: ContributionSurveyRevision, b: ContributionSurveyRevision) => number)

Parameters

Returns number

Parameters

Returns ((a: [ContributionSurveyRevision, any], b: [ContributionSurveyRevision, any]) => number)

Parameters

Returns number

Parameters

Returns ((a: [any, ContributionSurveyRevision], b: [any, ContributionSurveyRevision]) => number)

Parameters

Returns number

StaticguessSortOrder

Parameters

Returns ContributionSurveyRowSort

StaticidentifyCommentStatus

Parameters

Returns | Unknown | WithViolations | WithoutViolations | Missing | PresumptiveRemoval

Settings

On This Page

`Optional`comment

`Readonly`originalStatus

`Optional`statusIsolated

`Static` `Readonly`commentMatchRegex

`Static` `Readonly`Parser

`Static`getSorterFunction

`Static`guessSortOrder

`Static`identifyCommentStatus

Returns
| Unknown
| WithViolations
| WithoutViolations
| Missing
| PresumptiveRemoval