chore: renamed read event to data (#30)

Author: alessiofrittoli

README.md

@@ -245,7 +245,7 @@ The `StreamReader` class extends the `EventEmitter` class, providing events for
 
 ```ts
 const reader = new StreamReader( ... )
-reader.on( 'read', chunk => {
+reader.on( 'data', chunk => {
 	console.log( 'received chunk', chunk )
 } )
 ```
@@ -345,7 +345,7 @@ let resourceSize = 0
 if ( response.body ) {
 	const reader	= new StreamReader( response.body )
 	const decoder	= new TextDecoder()
-	reader.on( 'read', chunk => {
+	reader.on( 'data', chunk => {
 		const decoded = decoder.decode( chunk, { stream: true } )
 		resourceSize += chunk.BYTES_PER_ELEMENT * chunk.length
 	} )
@@ -368,7 +368,7 @@ const reader	= new StreamReader<Buffer, string>( stream.readable )
 
 streamData( { writer } )
 
-reader.on( 'read', chunk => {
+reader.on( 'data', chunk => {
 	console.log( chunk ) // chunk is type of string
 } )
 const chunks = await reader.read( chunk => chunk.toString( 'base64url' ) ) // `string[]`

__tests__/reader.test.ts

@@ -43,7 +43,7 @@ describe( 'StreamReader', () => {
 		streamData( { writer } )
 
 		const onRead: OnReadEventListener<Buffer> = jest.fn()
-		reader.on( 'read', onRead )
+		reader.on( 'data', onRead )
 		await reader.read()
 
 		expect( onRead ).toHaveBeenCalledTimes( 2 )
@@ -97,12 +97,12 @@ describe( 'StreamReader', () => {
 
 		const onRead: OnReadEventListener<Buffer> = jest.fn()
 		const onClose: OnCloseEventListener<Buffer> = jest.fn()
-		reader.on( 'read', onRead )
+		reader.on( 'data', onRead )
 		reader.on( 'close', onClose )
 
 		await reader.read()
 
-		expect( reader.listenerCount( 'read' ) ).toBe( 0 )
+		expect( reader.listenerCount( 'data' ) ).toBe( 0 )
 		expect( reader.listenerCount( 'close' ) ).toBe( 0 )
 	} )
 
@@ -163,7 +163,7 @@ describe( 'StreamReader', () => {
 
 		expect( onClose ).toHaveBeenCalledTimes( 0 )
 		expect( onClose2 ).toHaveBeenCalledTimes( 0 )
-		expect( reader.listenerCount( 'read' ) ).toBe( 0 )
+		expect( reader.listenerCount( 'data' ) ).toBe( 0 )
 		expect( reader.listenerCount( 'close' ) ).toBe( 0 )
 	} )
 
@@ -282,7 +282,7 @@ describe( 'StreamReader', () => {
 
 			streamData( { writer } )
 
-			reader.on( 'read', chunk => {
+			reader.on( 'data', chunk => {
 				expect( typeof chunk ).toBe( 'string' )
 			} )
 

src/index.ts

@@ -55,7 +55,7 @@ export class StreamReader<I = unknown, O = I> extends EventEmitter<StreamReaderE
 	 * Asynchronously reads on-demand stream data.
 	 * 
 	 * Optionally transform each chunk using the provided transform function.
-	 * Emits a 'read' event for each chunk after it has been processed.
+	 * Emits a 'data' event for each chunk after it has been processed.
 	 * If an error occurs during the reading process, it is caught and passed to the `error` method.
 	 * 
 	 * @template I - The type of the input chunks.
@@ -69,7 +69,7 @@ export class StreamReader<I = unknown, O = I> extends EventEmitter<StreamReaderE
 			for await ( const chunk of this.readChunks() ) {
 				const processed = ( typeof transform === 'function' ? await transform( chunk ) : chunk ) as ReadChunk<O>
 				this.receivedChunks.push( processed )
-				this.emit( 'read', processed )
+				this.emit( 'data', processed )
 			}
 			return (
 				this.close()
@@ -193,7 +193,7 @@ export class StreamReader<I = unknown, O = I> extends EventEmitter<StreamReaderE
 	 */
 	private removeListeners()
 	{
-		this.removeAllListeners( 'read' )
+		this.removeAllListeners( 'data' )
 		this.removeAllListeners( 'close' )
 		this.removeAllListeners( 'cancel' )
 

src/types.ts

@@ -38,7 +38,7 @@ export type StreamReaderEvents<O = unknown> = {
 	 * Emitted when a chunk of data is read from the stream.
 	 * @param {ReadChunk<O>} chunk - The chunk of data read from the stream.
 	 */
-	read: [ chunk: ReadChunk<O> ]
+	data: [ chunk: ReadChunk<O> ]
 
 
 	/**
@@ -68,7 +68,7 @@ export type StreamReaderEvents<O = unknown> = {
  * 
  * @template O The type of data being read from the stream and eventually transformed before the event is emitted.
  */
-export type OnReadEventListener<O = unknown> = Listener<StreamReaderEvents<O>, 'read'>
+export type OnReadEventListener<O = unknown> = Listener<StreamReaderEvents<O>, 'data'>
 
 
 /**