https://github.com/shinnn/empty-directory-tar

A Buffer of a Tar archive which only contains a single directory
https://github.com/shinnn/empty-directory-tar

Last synced: 27 days ago
JSON representation

A Buffer of a Tar archive which only contains a single directory

• Host: GitHub
• URL: https://github.com/shinnn/empty-directory-tar
• Owner: shinnn
• License: mit-0
• Created: 2019-02-23T20:27:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-02-23T20:34:59.000Z (over 5 years ago)
• Last Synced: 2024-10-06T12:18:38.075Z (about 1 month ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# empty-directory-tar

[![npm version](https://img.shields.io/npm/v/empty-directory-tar.svg)](https://www.npmjs.com/package/empty-directory-tar)

[![Build Status](https://travis-ci.com/shinnn/empty-directory-tar.svg?branch=master)](https://travis-ci.com/shinnn/empty-directory-tar)

A [Node.js](https://nodejs.org/) [`Buffer`](https://nodejs.org/api/buffer.html#buffer_class_buffer) of a [Tar](https://www.gnu.org/software/tar/manual/html_node/Standard.html) archive which only contains a single `directory` directory

```javascript

const emptyDirectoryTar = require('empty-directory-tar');

const {list} = require('tar');

list().on('entry', entry => {

  entry.type; //=> 'Directory'

  entry.path; //=> 'directory/'

}).end(emptyDirectoryTar);

```

Useful for testing if a library or an application correctly decompress a Tar archive.

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```

npm install empty-directory-tar

```

## API

```javascript

const emptyDirectoryTar = require('empty-directory-tar');

```

### emptyDirectoryTar

Type: `Buffer`

## License

[MIT No Attribution](./LICENSE) © 2019 Shinnosuke Watanabe