Skip to main content

write

method Socket.prototype.write
Jump to headingSocket.prototype.write(
buffer: Uint8Array | string,
cb?: (err?: Error) => void,
): boolean

Sends data on the socket. The second parameter specifies the encoding in the case of a string. It defaults to UTF8 encoding.

Returns true if the entire data was flushed successfully to the kernel buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.

The optional callback parameter will be executed when the data is finally written out, which may not be immediately.

See Writable stream write() method for more information.

Parameters Jump to heading

Jump to headingbuffer: Uint8Array | string
optional
Jump to headingcb: (err?: Error) => void

Return Type Jump to heading

boolean
Jump to headingSocket.prototype.write(
str: Uint8Array | string,
encoding?: BufferEncoding,
cb?: (err?: Error) => void,
): boolean

Parameters Jump to heading

Jump to headingstr: Uint8Array | string
optional
Jump to headingencoding: BufferEncoding
optional
Jump to headingcb: (err?: Error) => void

Return Type Jump to heading

boolean
Back to top