Skip to content

Commit b381739

Browse files
committed
Add explanatory JSDoc
1 parent c25999f commit b381739

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/commands/CommandBase.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ export abstract class DeserializedCommand<T> implements IDeserializedCommand {
2323

2424
export interface ISerializableCommand {
2525
serialize(version: ProtocolVersion): Buffer
26+
/**
27+
* Controls the command's execution order and batching.
28+
*
29+
* Lower values run **earlier**. Commands with different `runOrderGroup` values
30+
* will not be processed in the same batch.
31+
*
32+
* Defaults to 0. Use a **negative value** to ensure execution before the default group.
33+
*/
2634
runOrderGroup?: number
2735
}
2836

@@ -31,6 +39,7 @@ export abstract class BasicWritableCommand<T> implements ISerializableCommand {
3139
public static readonly rawName?: string
3240
public static readonly minimumVersion?: ProtocolVersion
3341

42+
/** @link ISerializableCommand.runOrderGroup */
3443
public runOrderGroup?: number = 0
3544

3645
protected _properties: T

0 commit comments

Comments
 (0)