Skip to content

@pumpkin-plugins/bedrock-addon-manager API / web/session / Transport

Interface: Transport ​

Defined in: packages/bedrock-addon-manager/src/web/session.ts:7

A connection as the session sees it. Everything is non-blocking.

Methods ​

abort() ​

abort(): void

Defined in: packages/bedrock-addon-manager/src/web/session.ts:17

Closes immediately, dropping unsent data.

Returns ​

void


finish() ​

finish(): boolean

Defined in: packages/bedrock-addon-manager/src/web/session.ts:15

Called every tick once everything is written. Returns true once the connection is closed.

Returns ​

boolean


read() ​

read(max): Uint8Array<ArrayBufferLike> | "closed" | null

Defined in: packages/bedrock-addon-manager/src/web/session.ts:9

Up to max bytes, null when nothing has arrived yet, 'closed' when the peer is gone.

Parameters ​

max ​

number

Returns ​

Uint8Array<ArrayBufferLike> | "closed" | null


writable() ​

writable(): number

Defined in: packages/bedrock-addon-manager/src/web/session.ts:11

How many bytes can be written right now.

Returns ​

number


write() ​

write(bytes): void

Defined in: packages/bedrock-addon-manager/src/web/session.ts:13

Queues bytes for sending. At most writable() bytes at a time.

Parameters ​

bytes ​

Uint8Array

Returns ​

void

Pumpkin Plugins documentation