# url-filea

> Create and read Windows Internet Shortcut files.

Latest version **1.0.0** (published 2020-01-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install url-filea
pnpm add url-filea
yarn add url-filea
bun add url-filea
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-01-03 |
| First published | 2020-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3 |
| Dependencies | 6 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Richie Bendall |
| Maintainers | richienb |
| Keywords | url, file, windows, shortcut, link |

## Links

- npm: https://www.npmjs.com/package/url-filea
- Repository: https://github.com/Richienb/url-filea
- npm.io page: https://npm.io/package/url-filea

## Dependencies (6)

- [ow](https://npm.io/package/ow.md) ^0.15.0
- [ini](https://npm.io/package/ini.md) ^1.3.5
- [map-obj](https://npm.io/package/map-obj.md) ^4.1.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [camelcase](https://npm.io/package/camelcase.md) ^5.3.1
- [@sindresorhus/is](https://npm.io/package/@sindresorhus/is.md) ^1.2.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-01-03
- 0.0.0 — 2020-01-03

## README

# URL Filea [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/url-filea/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/url-filea)

Create and read Windows Internet Shortcut files.

[![NPM Badge](https://nodei.co/npm/url-filea.png)](https://npmjs.com/package/url-filea)

## Install

```sh
npm install url-filea
```

## Usage

```js
const urlFile = require("url-filea");

(async () => {
    await urlFile("google.url", { url: "https://google.com" })

    await urlFile("google.url")
    //=> { url: "https://google.com" }
})()
```

## API

### urlFilea(filename, options?)

#### filename

Type: `string`

The name of the file to read or write to.

#### options

Type: `object`

The data to write. If not specified, the data is read instead.

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