Giter Club home page Giter Club logo

koa-asar's Introduction

简体中文

Using ASAR Files for Static Assets in Koa Middleware

Installation

npm install --save koa-asar

Usage

const Asar = require("koa-asar");
const Koa = require("koa");
const app = new Koa();

app.use(Asar(archive, options));

app.listen(3000);
console.log("listening on port 3000");

Parameters

  • archive - The path to the ASAR file.
  • options - Configuration options:
  • root - The website root directory, which can be understood as the URL prefix. Default value: /.
  • methods - HTTP methods to handle. Default value: ['GET'].
  • rewrite - File rewrite rules. The current value can be a function/object/string.
  • index - The default document name.
  • maxage - Cache duration. Unit: seconds.
  • maxAge - Same as maxage.
  • default - When the loaded file does not exist, then load the file configured for the current setting.

Rewrite Parameter Description

  • When the parameter is a function, the signature is as follows: rewrite(filename): Promise<string>.
  • When the parameter is an object, the key is the matched file name, and the value is the rewritten file name.
  • When the parameter is a string, any URL will return fixed file content.

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.