# cutter

**Repository Path**: mirrors_node-modules/cutter

## Basic Information

- **Project Name**: cutter
- **Description**: A cutter for buffer
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

cutter![travis-ci](https://secure.travis-ci.org/node-modules/cutter.png)
======

A cutter for head-body buffer.
Many network protocol will use packets composed of a fixed length "head" and a variable length "body", the "data" event emitted by node socket probably not a complete packet, but part of several packets. So this `cutter` will help to get packets.

## Usage

```js
var Cutter = require('cutter');
var net = require('net');

/**
 * must return length of head + body
 */
function packetLength(data) {
  return 4 + data[0] + (data[1] << 8) + (data[2] << 16);
}

var server = net.createServer(function(socket) {
  var cutter = new Cutter(4, packetLength);
  cutter.on('packet', function(packet) {
    var head = packet.slice(0, 4);
    var body = packet.slice(4, packet.length);
  });
  socket.on('data', function(data) {
    cutter.handleData(data);
  });

  cutter.on('error', function(err) {
    console.log(err.stack);
  });
});

server.listen(12345);
```

### Error Event

__When cutter parse packet error, it will emit an error event.__

## Installation

```
$ npm install cutter --save
```

## License
The MIT license