{"id":18544723,"url":"https://github.com/131/phar-fs","last_synced_at":"2025-06-28T17:05:26.378Z","repository":{"id":57322819,"uuid":"85474142","full_name":"131/phar-fs","owner":"131","description":"phar-stream wrapper for fs","archived":false,"fork":false,"pushed_at":"2018-05-25T21:20:24.000Z","size":60,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-26T08:42:25.701Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/131.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-19T12:27:20.000Z","updated_at":"2019-02-26T08:42:46.000Z","dependencies_parsed_at":"2022-08-25T22:41:31.106Z","dependency_job_id":null,"html_url":"https://github.com/131/phar-fs","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/131%2Fphar-fs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/131%2Fphar-fs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/131%2Fphar-fs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/131%2Fphar-fs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/131","download_url":"https://codeload.github.com/131/phar-fs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254282736,"owners_count":22045128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T20:17:25.497Z","updated_at":"2025-05-15T05:34:15.113Z","avatar_url":"https://github.com/131.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Motivation\r\nphar-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.\r\nIt's mosly intended to be used via [cnyks](https://github.com/131/cnyks)\r\n\r\n\r\n[![Build Status](https://travis-ci.org/131/phar-fs.svg?branch=master)](https://travis-ci.org/131/phar-fs)\r\n[![Coverage Status](https://coveralls.io/repos/github/131/phar-fs/badge.svg?branch=master)](https://coveralls.io/github/131/phar-fs?branch=master)\r\n[![Version](https://img.shields.io/npm/v/phar-fs.svg)](https://www.npmjs.com/package/phar-fs)\r\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)\r\n[![Code style](https://img.shields.io/badge/code%2fstyle-ivs-green.svg)](https://www.npmjs.com/package/eslint-plugin-ivs)\r\n\r\n\r\n\r\n\r\n# API\r\n## extract (return Promise)\r\n```\r\nvar phar = require('phar-fs');\r\nphar.extract(\"somephar_path.phar\").then(function() { console.log(\"All done\") });\r\n```\r\n\r\n\r\n\r\n# Credits / see also\r\n* [phar-stream](https://github.com/131/phar-stream)\r\n* [131](https://github.com/131)\r\n* [cnyks](https://github.com/131/cnyks)\r\n\r\n\r\n# License\r\n\r\nMIT\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F131%2Fphar-fs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F131%2Fphar-fs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F131%2Fphar-fs/lists"}