Class WritableCommand<T>`Abstract`

Base command type for a full writable command, which uses flags to indicate the changed properties

Type Parameters

T

Hierarchy

BasicWritableCommand<Partial<T>>
- WritableCommand

Index

Constructors

Properties

_properties flag runOrderGroup? MaskFlags? minimumVersion? rawName?

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new WritableCommand<T>(): WritableCommand<T>
Type Parameters
- T
Returns WritableCommand<T>
Overrides BasicWritableCommand.constructor
- Defined in src/commands/CommandBase.ts:64

Properties

`Protected` _properties

_properties: Partial<T>

flag

flag: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Static` `Optional` `Readonly` MaskFlags

MaskFlags?: {
[key: string]: number;
}

Type declaration

[key: string]: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Optional` `Readonly` rawName

rawName?: string

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from BasicWritableCommand.properties
- Defined in src/commands/CommandBase.ts:47

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
- Defined in src/commands/CommandBase.ts:75

`Abstract` serialize

serialize(version): Buffer
Parameters
- version: ProtocolVersion
Returns Buffer
Inherited from BasicWritableCommand.serialize
- Defined in src/commands/CommandBase.ts:55

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<T>
Returns boolean
- Defined in src/commands/CommandBase.ts:71

Generated using TypeDoc