Class HistoryEntry

Struct refering to an entry in the undo history stack.

Index

Constructors

Properties

_commandId _description

Accessors

commandId description

Methods

assign clone isEqual isEqual

Constructors

constructor

new HistoryEntry(description?: string, commandId?: number): HistoryEntry
Parameters
- Optionaldescription: string
- OptionalcommandId: number
Returns HistoryEntry

Properties

`Protected`_commandId

_commandId: number

`Protected`_description

_description: string

Accessors

commandId

get commandId(): number

Command id.

Returns number
set commandId(value: number): void
Parameters
- value: number
Returns void

description

get description(): string

Description of the command.

Returns string
set description(value: string): void
Parameters
- value: string
Returns void

Methods

assign

assign(other: Immutable<HistoryEntry>): HistoryEntry
Copies all properties defined by the prototype of HistoryEntry from other to this instance.
Parameters
- other: Immutable<HistoryEntry>
Returns HistoryEntry

clone

clone(): HistoryEntry

Clones this instance and returns a new HistoryEntry with identical values.

Returns HistoryEntry

isEqual

isEqual(this: Immutable<HistoryEntry>, other: Immutable<HistoryEntry>): boolean
Determines if this HistoryEntry instance is equal to the other instance.
Parameters
- this: Immutable<HistoryEntry>
- other: Immutable<HistoryEntry>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<HistoryEntry>, rhs: Immutable<HistoryEntry>): boolean
Determines if both HistoryEntry instances are equal.
Parameters
- lhs: Immutable<HistoryEntry>
- rhs: Immutable<HistoryEntry>
Returns boolean