# sarc-extractor

> Extract file(s) from SARC file.

Latest version **1.0.3** (published 2021-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install sarc-extractor
pnpm add sarc-extractor
yarn add sarc-extractor
bun add sarc-extractor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-02-02 |
| First published | 2021-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | FURI-J |
| Maintainers | furi-j |
| Keywords | SARC, Nintendo |

## Links

- npm: https://www.npmjs.com/package/sarc-extractor
- Repository: https://github.com/FURI-J/sarc-extractor
- Homepage: https://github.com/FURI-J/sarc-extractor#readme
- Issues: https://github.com/FURI-J/sarc-extractor/issues
- npm.io page: https://npm.io/package/sarc-extractor

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-02-02
- 1.0.2 — 2021-02-02
- 1.0.1 — 2021-02-01

## README

# sarc-extractor
`sarc-extractor` is an npm package that extracts file(s) from [SARC](http://mk8.tockdom.com/wiki/SARC_(File_Format)) file.

## Installation
[![npm version](https://badge.fury.io/js/sarc-extractor.svg)](https://badge.fury.io/js/sarc-extractor)

``` sh
npm i sarc-extractor
```
## Usage
The file(s) extracted from the SARC file will be output to to the same directory as the SARC file.

``` js
const sarcExtractor = require('sarc-extractor');
const extractedFileList = sarcExtractor.extract('<SARC file path>');
```

### Example
``` js
const sarcExtractor = require('sarc-extractor');
const extractedFileList = sarcExtractor.extract('/home/foo/bar.sarc');
// --> output ["/home/foo/bar/baz.msbt", "/home/foo/bar/qux.msbt"]
```

### npm run
``` sh
npm run extract -- <SARC file path>
```

---
_Source: https://npm.io/package/sarc-extractor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._