# @types/properties-reader

> TypeScript definitions for properties-reader

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

## Install

```sh
npm install @types/properties-reader
pnpm add @types/properties-reader
yarn add @types/properties-reader
bun add @types/properties-reader
```

## 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.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.3 |
| Published | 2023-11-07 |
| First published | 2017-07-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51436 |
| Maintainers | types |

## Links

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

## Recent versions

- 2.1.3 (latest) — 2023-11-07
- 2.1.1 (ts3.6) — 2021-07-08
- 2.1.0 (ts3.2) — 2020-10-04
- 0.0.2 (ts2.8) — 2020-02-11
- 0.0.1 (ts2.0) — 2017-08-21
- 2.1.2 — 2023-10-18
- 0.0.0 — 2017-07-27

## README

# Installation
> `npm install --save @types/properties-reader`

# Summary
This package contains type definitions for properties-reader (https://github.com/steveukx/properties).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/properties-reader.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/properties-reader/index.d.ts)
````ts
declare namespace PropertiesReader {
    type Value = string | number | boolean;

    interface Reader {
        get(propertyName: string): Value | null;
        getRaw(propertyName: string): string | null;
        path(): {};
        append(path: string): Reader;
        read(properties: string): Reader;
        set(propertyName: string, value: Value): Reader;
        length: number;
        each(iterator: (key: string, value: Value) => void): Reader;
        each<T>(iterator: (this: T, key: string, value: Value) => void, scope: T): Reader;
        getAllProperties(): { [key: string]: Value };
        clone(): Reader;
        save(destFile: string, onComplete?: (err: any, data: string) => void): Promise<string>;
        getByRoot(root: any): { [key: string]: Value };
        bindToExpress(app: object, basePath?: string, makePaths?: boolean): Reader;
    }

    interface AppenderOptions {
        allowDuplicateSections: boolean;
    }
    interface WriterOptions {
        saveSections: boolean;
    }

    interface FullOptions {
        appender?: AppenderOptions | undefined;
        writer?: WriterOptions | undefined;
    }
}

declare function PropertiesReader(
    path: string,
    encoding?: string,
    options?: PropertiesReader.AppenderOptions | PropertiesReader.WriterOptions | PropertiesReader.FullOptions,
): PropertiesReader.Reader;

export = PropertiesReader;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Zlatko Andonovski](https://github.com/Goldsmith42).

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