# @types/node-hrx

> TypeScript definitions for node-hrx

Latest version **0.1.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/node-hrx
pnpm add @types/node-hrx
yarn add @types/node-hrx
bun add @types/node-hrx
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2023-11-07 |
| First published | 2021-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/node-hrx
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-hrx
- npm.io page: https://npm.io/package/@types/node-hrx

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.1.3 (latest) — 2023-11-07
- 0.1.0 (ts3.7) — 2021-09-14
- 0.1.2 — 2023-10-18
- 0.1.1 — 2023-09-23

## README

# Installation
> `npm install --save @types/node-hrx`

# Summary
This package contains type definitions for node-hrx (https://github.com/issa-tseng/node-hrx#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-hrx.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-hrx/index.d.ts)
````ts
/// <reference types="node" />

import { Readable } from "stream";

export class Directory implements Iterable<string> {
    constructor(path: string, contents?: Record<string, HrxItem>, comment?: string | null);
    readonly path: string;
    readonly contents: Record<string, HrxItem>;
    readonly comment?: string;
    get(path: string): HrxItem | undefined;
    isDirectory(): this is Directory;
    isFile(): this is File;
    list(): string[];
    [Symbol.iterator](): Iterator<string>;
}

export class Archive extends Directory {
    constructor(contents?: Record<string, HrxItem>, comment?: string | null);
    readonly path: "";
}

export class File {
    constructor(path: string, body: string, comment?: string | null);
    readonly path: string;
    readonly body: string;
    readonly comment?: string;
    isDirectory(): this is Directory;
    isFile(): this is File;
}

export type HrxItem = File | Directory;

export class ParseProblem extends Error {
    constructor(message: string, position: { line: number; col: number }, details?: Record<string, unknown>);
    readonly line: number;
    readonly col: number;
    readonly details: {};
}

export class LexicalProblem extends Error {
    constructor(message: string, line: number, details?: { path?: string; [key: string]: unknown });
    readonly line: number;
    readonly details: {
        path?: string;
    };
}

export function archiveFromStream(stream: Readable): Promise<Archive>;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Christophe Coevoet](https://github.com/stof).

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