Clarify docs

This commit is contained in:
Vanilagy
2025-11-06 16:31:02 +01:00
parent 21cff32831
commit 5aabf6350a
+4 -1
View File
@@ -126,7 +126,10 @@ export class EncodedPacket {
}
}
/** If this packet is a metadata-only packet. Metadata-only packets don't contain their packet data. */
/**
* If this packet is a metadata-only packet. Metadata-only packets don't contain their packet data. They are the
* result of retrieving packets with {@link PacketRetrievalOptions.metadataOnly} set to `true`.
*/
get isMetadataOnly() {
return this.data === PLACEHOLDER_DATA;
}