IStatusBuilder

Interface for building Status objects.

​

Methods

​

status()

status(statusType: StatusType): IStatusBuilder

Adds a StatusType to the builder (Required).

​

Parameters

statusType

StatusType The status type to add.

​

Returns

IStatusBuilder IStatusBuilder The builder instance.

---

​

additionalData()

additionalData(additionalData: string): IStatusBuilder

Adds additional data to the builder (Optional).

​

Parameters

additionalData

string The additional data to add (limited to 64KB).

​

Throws

• InvalidArgumentError If additionalData exceeds 64KB.

​

Returns

IStatusBuilder IStatusBuilder The builder instance for method chaining.

---

​

build()

build(): IStatus

Builds and returns an IStatus object if all required fields are provided.

​

Returns

IStatus IStatus The constructed IStatus object.