Skip to content
Last Updated
Mar 28, 2025, 03:08

Class MinecraftLanDiscover ​

🏭 Constructors ​

constructor ​

ts
MinecraftLanDiscover(type: "udp4" | "udp6"= 'udp4'): MinecraftLanDiscover

Parameters ​

  • type: "udp4" | "udp6"

Return Type ​

  • MinecraftLanDiscover

Defined in: packages/client/lan.ts:25

🏷️ Properties ​

socket readonly ​

ts
socket: Socket

Defined in: packages/client/lan.ts:16

🔑 Accessors ​

isReady ​

Defined in: packages/client/lan.ts:21

🔧 Methods ​

addListener ​

ts
addListener(channel: "discover", listener: (event: LanServerInfo & { remote: RemoteInfo }) => void): this

Parameters ​

  • channel: "discover"
  • listener: (event: LanServerInfo & { remote: RemoteInfo }) => void

Return Type ​

  • this

Defined in: packages/client/lan.ts:11

bind ​

ts
bind(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/client/lan.ts:67

broadcast ​

ts
broadcast(inf: LanServerInfo): Promise<number>

Parameters ​

  • inf: LanServerInfo

Return Type ​

  • Promise<number>

Defined in: packages/client/lan.ts:58

destroy ​

ts
destroy(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/client/lan.ts:77

on ​

ts
on(channel: "discover", listener: (event: LanServerInfo & { remote: RemoteInfo }) => void): this

Parameters ​

  • channel: "discover"
  • listener: (event: LanServerInfo & { remote: RemoteInfo }) => void

Return Type ​

  • this

Defined in: packages/client/lan.ts:9

once ​

ts
once(channel: "discover", listener: (event: LanServerInfo & { remote: RemoteInfo }) => void): this

Parameters ​

  • channel: "discover"
  • listener: (event: LanServerInfo & { remote: RemoteInfo }) => void

Return Type ​

  • this

Defined in: packages/client/lan.ts:10

removeListener ​

ts
removeListener(channel: "discover", listener: (event: LanServerInfo & { remote: RemoteInfo }) => void): this

Parameters ​

  • channel: "discover"
  • listener: (event: LanServerInfo & { remote: RemoteInfo }) => void

Return Type ​

  • this

Defined in: packages/client/lan.ts:12