Synopsis

scrop is a simple function for cropping sequences (arrays, strings, buffers, anything with a slice method) to a given length.

Install

Node.js

With NPM

npm install scrop

From source

git clone https://github.com/pluma/scrop.git
cd scrop
npm install
make && make dist

Browser

With component

component install pluma/scrop

Learn more about component.

With bower

bower install scrop

Learn more about bower.

With a CommonJS module loader

Download the latest minified CommonJS release and add it to your project.

Learn more about CommonJS modules.

With an AMD module loader

Download the latest minified AMD release and add it to your project.

Learn more about AMD modules.

As a standalone library

Download the latest minified standalone release and add it to your project.

<script src="/your/js/path/scrop.globals.min.js"></script>

This makes the scrop module available in the global namespace.

Basic usage example

var scrop = require('scrop');

console.log(scrop([1, 2, 3], 2)); // [1, 2]
console.log(scrop('abc', 2)); // 'ab'
console.log(scrop(new Buffer([1, 2, 3]), 2)); // <Buffer 01 02>

API

scrop(arr:sequence, n:Number):sequence

Slices of the first n items and returns them as a new sequence.

scrop.rcrop(arr:sequence, n:Number):sequence

Slices of the last n items and returns them as a new sequence.

scrop.lcrop(arr:sequence, n:Number):sequence

Alias for scrop.

Unlicense

This is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.