io/streams

Documentation

• source: io/streams.ts

Overview

Classes

Streams

copy()

Copies all bytes from the input stream to the output stream. This method is generally used for smaller streams.

static copy(input: InputStream, output: OutputStream): void;

Parameter	Type	Description
input	InputStream	The source InputStream.
output	OutputStream	The destination OutputStream.

Returns

• Type: void
• Description:

copyLarge()

Copies all bytes from the input stream to the output stream using a large buffer, suitable for large file transfers.

static copyLarge(input: InputStream, output: OutputStream): void;

Parameter	Type	Description
input	InputStream	The source InputStream.
output	OutputStream	The destination OutputStream.

Returns

• Type: void
• Description:

getResourceAsByteArrayInputStream()

Creates a new InputStream from a resource accessible via the class loader. This is typically used to read bundled resources within the application runtime.

static getResourceAsByteArrayInputStream(path: string): InputStream;

Parameter	Type	Description
path	string	The path to the resource.

Returns

• Type: InputStream
• Description: A new InputStream instance for the resource.

createByteArrayInputStream()

Creates a new InputStream from a JavaScript byte array (`any[]`).

static createByteArrayInputStream(data: any): InputStream;

Parameter	Type	Description
data	any	The JavaScript array of byte values (`number[]`).

Returns

• Type: InputStream
• Description: A new InputStream instance initialized with the byte data.

createByteArrayOutputStream()

Creates a new OutputStream that writes data into an in-memory byte array. This is typically used as a buffer to capture output before processing it.

static createByteArrayOutputStream(): OutputStream;

Returns

• Type: OutputStream
• Description: A new OutputStream instance backed by a byte array.

createInputStream()

Wraps a native (Java) InputStream object into a new JavaScript InputStream instance.

static createInputStream(native: any): InputStream;

Parameter	Type	Description
native	any	The underlying native InputStream object.

Returns

• Type: InputStream
• Description: A new InputStream wrapper.

createOutputStream()

Wraps a native (Java) OutputStream object into a new JavaScript OutputStream instance.

Note: This method is not static in the original definition, but is placed here for completeness and consistency with other factory methods.

createOutputStream(native: any): OutputStream;

Parameter	Type	Description
native	any	The underlying native OutputStream object.

Returns

• Type: OutputStream
• Description: A new OutputStream wrapper.

InputStream

read()

Reads the next byte of data from this input stream.

read(): number;

Returns

• Type: number
• Description: The next byte of data, or -1 if the end of the stream is reached.

readBytes()

Reads all remaining bytes from the stream and returns them as a JavaScript array.

readBytes(): void;

Returns

• Type: void
• Description: A JavaScript array (`number[]`) of the byte values.

readBytesNative()

Reads all remaining bytes from the stream and returns the native Java byte array.

readBytesNative(): void;

Returns

• Type: void
• Description: The native Java byte array object.

readText()

Reads all remaining bytes from the stream and converts them to a string using the platform's default character encoding.

readText(): string;

Returns

• Type: string
• Description: The content of the stream as a string.

close()

Closes this input stream and releases any system resources associated with it.

close(): void;

Returns

• Type: void
• Description:

isValid()

Checks if the underlying native stream object is defined and non-null.

isValid(): boolean;

Returns

• Type: boolean
• Description: True if the stream is valid, false otherwise.

OutputStream

write()

Writes the specified byte to this output stream.

write(byte: number): void;

Parameter	Type	Description
byte	number	The byte (as a number 0-255) to write.

Returns

• Type: void
• Description:

writeBytes()

Writes the entire content of a JavaScript byte array to this output stream.

writeBytes(data: any): void;

Parameter	Type	Description
data	any	The JavaScript array (`number[]`) of byte values to write.

Returns

• Type: void
• Description:

writeBytesNative()

Writes the entire content of a native Java byte array to this output stream.

writeBytesNative(data: any): void;

Parameter	Type	Description
data	any	The native Java byte array object to write.

Returns

• Type: void
• Description:

writeText()

Converts the string to bytes using the platform's default character encoding and writes them to this output stream.

writeText(text: string): void;

Parameter	Type	Description
text	string	The string content to write.

Returns

• Type: void
• Description:

close()

Closes this output stream and releases any system resources associated with it.

close(): void;

Returns

• Type: void
• Description:

getBytes()

Retrieves the content written to this stream as a JavaScript byte array. This is typically used with a ByteArrayOutputStream.

getBytes(): void;

Returns

• Type: void
• Description: A JavaScript array (`number[]`) of the byte values written to the stream.

getBytesNative()

Retrieves the content written to this stream as the native Java byte array. This is typically used with a ByteArrayOutputStream.

getBytesNative(): void;

Returns

• Type: void
• Description: The native Java byte array object.

getText()

Retrieves the content written to this stream as a string using the platform's default character encoding. This is typically used with a ByteArrayOutputStream.

getText(): string;

Returns

• Type: string
• Description: The content of the stream as a string.

isValid()

Checks if the underlying native stream object is defined and non-null.

isValid(): boolean;

Returns

• Type: boolean
• Description: True if the stream is valid, false otherwise.