Installations

npm install @types/koa-static-server

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Pull Requests

Open

154

Total

61,824

Closed

9,749

Merged

51,921

Issues

Open

565

Total

8,085

Closed

7,520

Releases

1

0.1.450

Updated on Sep 04, 2019

View All 1 releases

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.84%)

JavaScript (0.15%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

NOASSERTION License

50,041 Stars

89,741 Commits

30,435 Forks

640 Watchers

6 Branches

9,957 Contributors

Updated on Jul 15, 2025

Maintainers

1

View All 9,957 Contributors

Package Meta Information

Latest Version

1.5.3

Package Id

@types/koa-static-server@1.5.3

Unpacked Size

5.90 kB

Size

2.02 kB

File Count

5

Published on

Nov 07, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

@types/koa

Installation

npm install --save @types/koa-static-server

Summary

This package contains type definitions for koa-static-server (https://github.com/pkoretic/koa-static-server).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-static-server.

index.d.ts

1/* =================== USAGE ===================
2
3    import serve = require("koa-static-server");
4    var Koa = require('koa');
5
6    var app = new Koa();
7    app.use(serve(serve({rootDir: 'web'}));
8
9 =============================================== */
10import { Middleware } from "koa";
11
12declare function KoaStaticServer(options: KoaStaticServer.Options): Middleware;
13
14declare namespace KoaStaticServer {
15    interface Options {
16        /**
17         * directory that is to be served
18         */
19        rootDir?: string | undefined;
20        /**
21         * optional rewrite path
22         */
23        rootPath?: string | undefined;
24        /**
25         * optional default file to serve if requested static is missing
26         */
27        notFoundFile?: string | undefined;
28        /**
29         * request access log to console
30         */
31        log?: boolean | undefined;
32        /**
33         * don't execute any downstream middleware. defaults to true
34         */
35        last?: boolean | undefined;
36        /**
37         * Browser cache max-age in milliseconds. defaults to 0
38         */
39        maxage?: number | undefined;
40        /**
41         * Allow transfer of hidden files. defaults to false
42         */
43        hidden?: boolean | undefined;
44        /**
45         * Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested
46         */
47        gzip?: boolean | undefined;
48        /**
49         * Try to serve the brotli version of a file automatically when brotli is supported by a client and in the requested
50         */
51        brotli?: boolean | undefined;
52        index?: string | undefined;
53    }
54}
55
56export = KoaStaticServer;
57

Additional Details

Last updated: Tue, 07 Nov 2023 09:09:38 GMT
Dependencies: @types/koa

Credits

These definitions were written by wulunyi.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

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

9

Code-Review

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

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

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

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-07-14

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