# get-file-properties

> Gets file metadata

Latest version **1.0.1** (published 2019-10-30) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install get-file-properties
pnpm add get-file-properties
yarn add get-file-properties
bun add get-file-properties
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-10-30 |
| First published | 2019-10-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Jack Barry |
| Maintainers | jack-barry |
| Keywords | wmic, file properties, file metadata |

## Links

- npm: https://www.npmjs.com/package/get-file-properties
- Repository: https://github.com/Jack-Barry/get-file-properties
- Homepage: https://github.com/Jack-Barry/get-file-properties#readme
- Issues: https://github.com/Jack-Barry/get-file-properties/issues
- npm.io page: https://npm.io/package/get-file-properties

## Recent versions

- 1.0.1 (latest) — 2019-10-30
- 1.0.0 — 2019-10-30

## README

# GetFileProperties

## What is it?

Zero dependency tool for getting a file's properties/metadata.

## Limitations

Currently only works on Windows, though I'm open to pull requests to add
functionality for MacOS and Linux.

## Usage

```none
npm i get-file-properties
```

```ts
import { getFileProperties, WmicDataObject } from 'get-file-properties'

async function demo() {
  // Ensure you are using double backslashes in your file path
  const filepath: string = 'C:\\path\\to-my\\file.txt'
  let metadata: WmicDataObject

  metadata = await getFileProperties(filepath)
  console.log(metadata.FileSize)
}
```

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