# koa-stream

**Repository Path**: mirrors_ulisesbocchio/koa-stream

## Basic Information

- **Project Name**: koa-stream
- **Description**: Send file with range requests
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# koa-stream [![Build Status](https://travis-ci.org/claudetech/koa-stream.svg?branch=master)](https://travis-ci.org/claudetech/koa-stream) [![Coverage Status](https://coveralls.io/repos/claudetech/koa-stream/badge.svg)](https://coveralls.io/r/claudetech/koa-stream)

Helper to stream files and buffers with range requests using koa.
This can be used with `video` tags, and other resource using the `Range` header.

The implementation follows [RFC 7233](https://tools.ietf.org/html/rfc7233).

## Installation

```sh
$ npm install koa-stream
```

## Usage

### Stream Files

```javascript
var stream = require('koa-stream');
var path   = require('path');
var app    = require('koa');

app.use(function *() {
    yield stream.file(this, 'my-video.mp4', {root: path.join(__dirname, '/public')});
});
```

### Stream Buffers

```javascript
var stream = require('koa-stream');
var path   = require('path');
var app    = require('koa');

app.use(function *() {
    stream.buffer(this, new Buffer([1,2,3]), 'image/png', {allowDownload: true});
});
```

See [sample/index.js](./sample/index.js) for a working example.

### Options

* `root`: the directory from which file paths will be resolved
* `allowDownload`: allow to return the file instead of streaming it if not `Range` header is provided