npmpackage.info

Gathering detailed insights and metrics for koa-static-server

Other packages similar to koa-static-server

koa-static-router

1.5.0

Serving for koa-send to be a static server

lws-static

3.1.1

Lws middleware wrapper for koa-static

@types/koa-static-server

1.5.3

TypeScript definitions for koa-static-server

koa-simple-static

4.1.2

Simple caching static file server for Koa

koa-static-server

Static file serving middleware for koa with directory, rewrite and index support

1.5.2

MIT

JavaScript

7.15 kB

872,232 2.9

Installations

npm install koa-static-server

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

12.16.2

NPM Version

6.14.4 Pull Requests

Open

1

Total

12

Closed

1

Merged

10

Issues

Open

1

Total

12

Closed

11

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 8 Contributors

Languages

JavaScript

JavaScript (100%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

pkoretic

Download Statistics

Total Downloads

872,232

Last Day

211

Last Week

1,100

Last Month

4,893

Last Year

63,972

GitHub Statistics

MIT License

61 Stars

77 Commits

10 Forks

3 Watchers

2 Branches

8 Contributors

Updated on Mar 11, 2024

Bundle Size

20.46 kB

Minified

7.15 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.5.2

Package Id

koa-static-server@1.5.2

Size

3.03 kB

NPM Version

6.14.4

Node Version

12.16.2

Published on

May 15, 2020

Total Downloads

Cumulative downloads

Total Downloads

872,232

Last Day

22.7%

211

Compared to previous day

Last Week

1.9%

1,100

Compared to previous week

Last Month

13.5%

4,893

Compared to previous month

Last Year

-4.7%

63,972

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

koa-send upath

koa-static-server

static file serving middleware for koa with directory, rewrite and index support

Installation

1$ npm install koa-static-server

API

1var koa = require('koa')
2var app = koa()
3app.use(require('koa-static-server')(options))

Options

rootDir {string} directory that is to be served
rootPath {string} optional rewrite path, (defaults to "/")
notFoundFile {string} optional default file to serve if requested static is missing
log {boolean} request access log to console
last {boolean} don't execute any downstream middleware. (defaults to true)
maxage Browser cache max-age in milliseconds. (defaults to 0)
hidden Allow transfer of hidden files. (defaults to false)
index Name of the index file to serve automatically when visiting root location. (defaults to "index.html", use "" to disable)
gzip Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. (defaults to true)

Example

See examples for code examples

1// example 'web' directory
2// web/index.html
3// web/file.txt
4
5var serve = require('koa-static-server')
6var app = require('koa')()
7
8// root index support
9// GET /
10// returns index.html
11// GET /file.txt
12// returns file.txt
13app.use(serve({rootDir: 'web'}))
14
15// folder support
16// GET /web/
17// returns /web/index.html
18// GET /web/file.txt
19// returns /web/file.txt
20app.use(serve({rootDir: 'web', rootPath: '/web'}))
21
22// index support
23// GET /
24// returns /file.txt
25app.use(serve({rootDir: 'web', index: 'file.txt'}))
26
27// rewrite support
28// GET /web/
29// returns 404
30// GET /admin
31// returns /admin/index.html
32app.use(serve({rootDir: 'web', rootPath: '/admin'}))
33
34app.listen(3000)
35
36console.log('listening on port 3000')

Support

Issues - open new issue
mail - petar.koretic@gmail.com

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.9

/10

Last Scanned on 2025-02-17

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More