# narloader

> NarLoader - Nanika ARchive Loader

Latest version **2.0.2** (published 2018-06-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install narloader
pnpm add narloader
yarn add narloader
bun add narloader
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2018-06-24 |
| First published | 2014-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | narazaka |
| Maintainers | narazaka |
| Keywords | nar, ukagaka |

## Links

- npm: https://www.npmjs.com/package/narloader
- Repository: https://github.com/Ikagaka/NarLoader
- Homepage: https://github.com/Ikagaka/NarLoader#readme
- Issues: https://github.com/Ikagaka/NarLoader/issues
- npm.io page: https://npm.io/package/narloader

## Dependencies (3)

- [fso](https://npm.io/package/fso.md) ^2.5.15
- [jszip](https://npm.io/package/jszip.md) ^3.1.5
- [nanika-storage](https://npm.io/package/nanika-storage.md) ^3.0.2

## Recent versions

- 2.0.2 (latest) — 2018-06-24
- 2.0.1 — 2018-02-18
- 2.0.0 — 2018-02-18
- 1.0.0 — 2016-11-23
- 0.7.2 — 2016-08-07
- 0.7.1 — 2015-12-12
- 0.7.0 — 2015-12-12
- 0.6.1 — 2015-12-12
- 0.5.2 — 2015-05-02
- 0.5.1 — 2015-01-07
- 0.5.0 — 2015-01-07
- 0.4.0 — 2014-12-13
- 0.2.1 — 2014-12-11
- 0.2.0 — 2014-12-11
- 0.1.0 — 2014-12-09
- … 2 more at https://npm.io/package/narloader/versions

## README

NarLoader - Nanika ARchive Loader
==========================

[![Greenkeeper badge](https://badges.greenkeeper.io/Ikagaka/NarLoader.svg)](https://greenkeeper.io/)

[Nanika ARchive](http://usada.sakura.vg/contents/install.html) (*.nar) loader

Installation
--------------------------

```
npm install narloader
```

Usage
--------------------------

```typescript
import * as NarLoader from "narloader";
const buffer = (nar data ArrayBuffer);
NarLoader.loadFromBuffer(buffer).then((directory) => ...);
```

### on browser

You can bundle NarLoader by webpack / browserify with [BrowserFS](https://github.com/jvilk/BrowserFS#using-with-browserify-and-webpack)' instruction.

API
--------------------------

```typescript
/**
 * load nar from path
 * @param narPath nar file path
 */
export async function loadFromPath(narPath: string): Promise<NanikaContainerSyncDirectory>;

/**
 * load nar from URI
 * @param narUri nar file URI
 */
export async function loadFromURI(narUri: URL | string): Promise<NanikaContainerSyncDirectory>;

/**
 * load nar from buffer
 * @param nar nar file buffer
 */
export async function loadFromBuffer(nar: string | ArrayBuffer | Uint8Array | Buffer | Blob): Promise<NanikaContainerSyncDirectory>;
```

License
--------------------------

This is released under [MIT License](http://narazaka.net/license/MIT?2018).

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