https://github.com/131/phar-fs

phar-stream wrapper for fs
https://github.com/131/phar-fs

Last synced: 12 months ago
JSON representation

phar-stream wrapper for fs

• Host: GitHub
• URL: https://github.com/131/phar-fs
• Owner: 131
• License: mit
• Created: 2017-03-19T12:27:20.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-05-25T21:20:24.000Z (about 8 years ago)
• Last Synced: 2025-04-26T08:42:25.701Z (about 1 year ago)
• Language: JavaScript
• Size: 58.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Motivation

phar-fs is a simple fs wrapper for the [phar-stream](https://github.com/131/phar-stream) API. It allows **phar** archive ([PHP archive](https://en.wikipedia.org/wiki/PHAR_(file_format))) file extraction for nodejs.

It's mosly intended to be used via [cnyks](https://github.com/131/cnyks)

[![Build Status](https://travis-ci.org/131/phar-fs.svg?branch=master)](https://travis-ci.org/131/phar-fs)

[![Coverage Status](https://coveralls.io/repos/github/131/phar-fs/badge.svg?branch=master)](https://coveralls.io/github/131/phar-fs?branch=master)

[![Version](https://img.shields.io/npm/v/phar-fs.svg)](https://www.npmjs.com/package/phar-fs)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

[![Code style](https://img.shields.io/badge/code%2fstyle-ivs-green.svg)](https://www.npmjs.com/package/eslint-plugin-ivs)

# API

## extract (return Promise)

```

var phar = require('phar-fs');

phar.extract("somephar_path.phar").then(function() { console.log("All done") });

```

# Credits / see also

* [phar-stream](https://github.com/131/phar-stream)

* [131](https://github.com/131)

* [cnyks](https://github.com/131/cnyks)

# License

MIT