Open In App

Node.js Buffer.copy() Method

Last Updated : 11 Apr, 2023
Improve
Improve
Like Article
Like
Save
Share
Report

Buffer is a temporary memory storage that stores the data when it is being moved from one place to another. It is like an array of integers. The Buffer.copy() method simply copies all the values from the input buffer to another buffer. 

Syntax:

buffer.copy( target, targetStart, sourceStart, sourceEnd )

Parameters: This method accepts two parameters as mentioned above and described below:

  • target: It is a buffer in which you need to copy all the values.
  • targetStart: It refers to the starting index from which the elements of the target buffer will begin writing. Its default value is 0.
  • sourceStart: It is the index of the input buffer from which the copying of values will start. Its default value is 0.
  • sourceEnd: The index of input buffer till which the copying of values will be done. Its default value is a buffer.length size.

Return Value: This method returns the number that indicates the number of bytes copied. 

Note: Copies the values from the input buffer and overwrites them to the output buffer even if the target memory regions (indexes) already exist. Copies data from a region of the input buffer to a region in the target buffer even if the target memory region overlaps with the input buffer.

Example 1: The below example illustrates the use of Buffer.includes() Method in Node.js

javascript




// Node.js program to demonstrate the
// Buffer.copy() Method
 
// Creating a buffer
let buffer2 = Buffer.from('for');
 
let buffer1 = Buffer.from('GeeksandGeeks');
 
buffer2.copy(buffer1, 5, 0);
 
console.log(buffer1.toString());


Output: 

GeeksforGeeks

Example 2: The below example illustrates the use of Buffer.includes() Method in Node.js

javascript




// Node.js program to demonstrate the
// Buffer.copy() Method
 
let buffer2 = Buffer.allocUnsafe(5);
 
let buffer1 = Buffer.from('Geeks');
 
for (let i = 0; i < 5; i++) {
 
    // Adds: 'a b c d e' as 97 98 99 100 101
    // are their respective ASCII values
    buffer2[i] = i + 97;
}
 
buffer2.copy(buffer1, 2);
 
// Prints 'Geabc' as the input buffer1
// carries 'Geeks' and we provided the
// targetStart index as 2
// so elements will replace the values in
// buffer1 starting from index 2
 
console.log(buffer1.toString());


Output:

Geabc

Note: The above program will compile and run by using the node index.js command. 

Reference: https://nodejs.org/api/buffer.html#buffer_buf_copy_target_targetstart_sourcestart_sourceend



Similar Reads

Node.js Buffer.buffer Property
The Buffer.buffer property is an inbuilt application programming interface of class Buffer within buffer module which is used to get the object of array buffer equivalent to this buffer object. Syntax: const buf.buffer Return Value: This property returns the object of array buffer. Example 1: Filename: index.js C/C++ Code // Node.js program to demo
1 min read
Node.js Buffer.readUInt16LE() Method
The Buffer.readUInt16LE() method is an inbuilt application programming interface of class Buffer within Buffer module which is used to read an unsigned 16-bit integer from buffer at the specified offset with specified little endian format. Syntax: Buffer.readUInt16LE( offset ) Parameters: This method accepts single parameter offset which denotes th
2 min read
Node.js Buffer.readUInt32BE() Method
The Buffer.readUInt32BE() method is an inbuilt application programming interface of class Buffer within the Buffer module which is used to read 32-bit value from an allocated buffer at a specified offset. Syntax: Buffer.readUInt32BE( offset ) Parameters: This method accept single parameter offset which specifies the number of bytes to skip before r
2 min read
Node.js Buffer.allocUnsafe() Method
The Buffer.allocUnsafe() method is an inbuilt application programming interface of class Buffer with in Buffer module which is used to allocate the buffer of given size but not initialize it. Syntax: const Buffer.allocUnsafe( size) Parameters: This method accepts a single parameter size which holds the desired size of the buffer. Return value: It a
1 min read
Node.js Buffer.writeInt32BE() Method
The Buffer.writeInt32BE() method is an inbuilt application programming interface of class Buffer within Buffer module which is used to write integer value to buffer at the specified offset with the big-endian format, integer value should be a valid signed 32-bit integer. Error is thrown if the value is outside the range of signed 32-bit integer.Int
2 min read
Node.js Buffer.slice() Method
Buffer is a temporary memory storage that stores the data when it is being moved from one place to another, it's like an array of integers. The Buffer.slice() method returns a new Buffer that points to the same memory location as that of the input Buffer with only the cropped elements. Syntax: buffer.slice( start, end ) Parameters: This method acce
2 min read
Node.js Buffer.indexOf() Method
Buffer is a temporary memory storage which stores the data when it is being moved from one place to another. It is like the array of integers. The Buffer.indexOf() method firstly checks for the input value, if it present in the buffer then it returns the first position (index) from where the value is starting. Syntax: buffer.indexOf( value, start,
2 min read
Node.js Buffer.readFloatLE() Method
The buf.readFloatLE() method is used to read a 32 bit float number from Buffer class with specified endian format. It facilitate interaction among octet streams inside TCP streams, operations of the file system and various other factors. Syntax: buffer.readFloatLE( integer ) Parameters: This method accepts single parameter offset which holds the va
2 min read
Node.js Buffer.readInt32BE() Method
The Buffer.readInt32BE() method is used to read 32 bit integer from a buffer object at a given offset and returns the result in Big endian. Syntax: buffer.readInt32BE( offset ) Parameters: This method accepts a single parameter offset which specifies the position of buffer object. It represents the number of bytes to skip before starting to read. T
2 min read
Node.js Buffer.readInt32LE() Method
The Buffer.readInt32LE() method is used to read a 32 bit integer from a buffer object at a given offset and returns the result in Little endian. Syntax: buffer.readInt32LE( offset ) Parameters: This method accepts a single parameter offset which specifies the position of buffer object. It represents number of bytes to skip before starting to read.
2 min read