Git Product home page Git Product logo

awesome-static's Introduction

Awesome-Static Build Status npm TypeScript

Koa static file serving middleware base on koa-send.

Feature

Some new features compared to koa-static.

  • 🐒Set the route map to static file directory
  • ☀️More than GET and HEAD
  • ☕Develop with Typescript

Installation

npm

npm install awesome-static

yarn

yarn add awesome-static

Usage

const Koa = require('koa');
const static = require('awesome-static');
const app = new Koa();

app.use(
  static('public', {
    allowMethods: ['GET', 'HEAD', 'POST'],
    route: 'hello',
  }),
);

app.listen(8080);

See /example.

API

AwesomeStatic(root, options);
  • root root directory string. nothing above this root directory can be served (Type: string).
  • options options object (Type:AwesomeOptions).

[Type] AwesomeOptions

Extends options from koa-static

  • route route for mapping to a static server (Type:string).
  • allowMethods HTTP method for allow access static file (Type:HTTPMethod).

[Type] HTTPMethod

GET | HEAD | POST | PUT | DELETE

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.