@studiowebux/static NPM

Webux Static

This module uses express to serve static files

npm i --save @studiowebux/static

npm i --save @studiowebux/static

npm i --save @studiowebux/static

Provide an array of path and local directory (Key/Value), the module will automatically serve those paths for external access.

Note You must load the static resources after the API routes to avoid issues.

config/static.js

module.exports = {
  resources: [
    { path: "/api", resource: "./api" },
    { path: "/assets", resource: "./assets" }
  ]
};

Key	Description	Mandatory
options	(Default: {}) The resources to expose	Yes
app	(Default: None) The express application	Yes
express	(Default: None) The express object	Yes
log	(Default: Console) If a custom logger is required	No

serveStatic function returns a Promise,

serveStatic(options, app, express, log);

For examples, check the /examples directory

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

SEE LICENSE IN license.txt

4 years ago

4 years ago

5 years ago