# lws-index

> Serve-index middleware plugin for lws

Latest version **3.1.1** (published 2022-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install lws-index
pnpm add lws-index
yarn add lws-index
bun add lws-index
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2022-06-22 |
| First published | 2017-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=12.17 |
| Dependencies | 1 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Lloyd Brookes |
| Maintainers | 75lb |
| Keywords | lws, lws-middleware, index, server, backend |

## Links

- npm: https://www.npmjs.com/package/lws-index
- Repository: https://github.com/lwsjs/index
- Homepage: https://github.com/lwsjs/index#readme
- Issues: https://github.com/lwsjs/index/issues
- npm.io page: https://npm.io/package/lws-index

## Dependencies (1)

- [serve-index-75lb](https://npm.io/package/serve-index-75lb.md) ^2.0.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.1.1 (latest) — 2022-06-22
- 3.1.0 — 2021-08-14
- 3.0.2 — 2021-07-06
- 3.0.1 — 2021-07-06
- 3.0.0 — 2021-07-06
- 2.0.0 — 2020-02-09
- 1.0.5 — 2019-07-15
- 1.0.4 — 2019-06-09
- 1.0.3 — 2019-06-09
- 1.0.2 — 2019-06-05
- 1.0.1 — 2019-06-03
- 1.0.0 — 2019-05-27
- 0.4.0 — 2018-04-11
- 0.3.3 — 2017-07-08
- 0.3.2 — 2017-07-01
- … 5 more at https://npm.io/package/lws-index/versions

## README

[![view on npm](https://badgen.net/npm/v/lws-index)](https://www.npmjs.org/package/lws-index)
[![npm module downloads](https://badgen.net/npm/dt/lws-index)](https://www.npmjs.org/package/lws-index)
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/lwsjs/index)](https://github.com/lwsjs/index/network/dependents?dependent_type=REPOSITORY)
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/lwsjs/index)](https://github.com/lwsjs/index/network/dependents?dependent_type=PACKAGE)
[![Node.js CI](https://github.com/lwsjs/index/actions/workflows/node.js.yml/badge.svg)](https://github.com/lwsjs/index/actions/workflows/node.js.yml)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# lws-index

[Lws](https://github.com/lwsjs/lws) middleware plugin to serve directory listings. Wraps [serve-index](https://github.com/expressjs/serve-index), typically used alongside [lws-static](https://github.com/lwsjs/static).

Adds the following options to lws.

```
--index.root path              Index root directory, defaults to the value of --directory or the current directory.
--index.hidden                 Show hidden files.
--index.view name              Display mode, either `tiles` or `details`. Defaults to tiles.
```

* * *

&copy; 2016-22 Lloyd Brookes \<75pound@gmail.com\>.

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