Interface: MinecraftStalkResult

Defined in: src/minecraft/minecraft.ts:34

Represents the result of a Minecraft player profile query. This interface encapsulates the status of the request, any associated player profile data, and error information for handling responses effectively.

Properties

status

• Type: number
• Description: Indicates the HTTP status code of the response. A value of 200 typically signifies success, while other values may indicate various error states.

data?

• Type: MinecraftProfile | undefined
• Description: Optional. Contains the player profile details if the request was successful and the profile exists. If the profile is not found or there is an error, this property may be omitted.

error?

• Type: string | undefined
• Description: Optional. Provides a description of the error that occurred during the request. This field is populated only if the status code indicates a failure.

reason?

• Type: string | undefined
• Description: Optional. Supplies additional context regarding the error. This can help in debugging or user notifications when a query fails to retrieve the profile.