setup-extract
> Classify and extract tar, zip, 7z, and executable archives.
## Install
```sh
npm install --save setup-extract
```
## Usage
```ts
import { extractZip, getArchiveType, getExtractFunction } from "setup-extract"
const extract = getExtractFunction(getArchiveType("tool.zip"))
await extract("/tmp/tool.zip", "/tmp/tool")
await extractZip("/tmp/another.zip", "/tmp/another")
```
Extraction functions accept optional archive-tool dependencies. Supply `setupSevenZip` when 7z is unavailable, or `setupTar` when tar is unavailable; each callback is invoked only when its executable is needed.
## API
### `ArchiveToolDependencies`
```ts
type ArchiveToolDependencies = {
setupSevenZip?: () => Promise
setupTar?: () => Promise
}
```
### `ExtractFunction`
The common extractor shape: `(file, dest, dependencies?) => Promise`.
### `ArchiveType`
The archive classifications `Tar`, `TarGz`, `TarXz`, `Zip`, and `SevenZip`.
### `getArchiveType`
Classifies an archive path by its extension, defaulting unknown extensions to 7z.
### `getExtractFunction`
Selects the platform-appropriate extractor for an `ArchiveType`.
### Extractors
`extract7Zip`, `extractExe`, `extractZip`, `extractTarByExe`, `extractTar`, and `extractXar` extract their respective archive formats. The tar and xar functions are re-exported from the underlying action tool-cache implementation.