Search the reference...

/

Symbol

udpSocket

function udpSocket<DataBinaryType extends keyof BinaryTypeList = 'buffer'>(options: SocketOptions<DataBinaryType>): Promise<Socket<DataBinaryType>>

Create a UDP socket

@param options

The options to use when creating the server

function udpSocket<DataBinaryType extends keyof BinaryTypeList = 'buffer'>(options: ConnectSocketOptions<DataBinaryType>): Promise<ConnectedSocket<DataBinaryType>>

Create a UDP socket

@param options

The options to use when creating the server

Referenced types

interface SocketOptions<DataBinaryType extends BinaryType>

binaryType?: DataBinaryType
hostname?: string
port?: number
socket?: SocketHandler<DataBinaryType>

interface Socket<DataBinaryType extends BinaryType>

readonly address: SocketAddress
readonly binaryType: keyof BinaryTypeList
readonly closed: boolean
readonly hostname: string
readonly port: number
close(): void
ref(): void
reload(handler: SocketHandler<DataBinaryType>): void
send(data: Data, port: number, address: string): boolean
sendMany(packets: readonly number | Data[]): number
unref(): void

interface ConnectSocketOptions<DataBinaryType extends BinaryType>

binaryType?: DataBinaryType
connect: { hostname: string; port: number }
hostname?: string
port?: number
socket?: ConnectedSocketHandler<DataBinaryType>

interface ConnectedSocket<DataBinaryType extends BinaryType>

readonly address: SocketAddress
readonly binaryType: keyof BinaryTypeList
readonly closed: boolean
readonly hostname: string
readonly port: number
readonly remoteAddress: SocketAddress
close(): void
ref(): void
reload(handler: ConnectedSocketHandler<DataBinaryType>): void
send(data: Data): boolean
sendMany(packets: readonly Data[]): number
unref(): void