0.0.0-experimental.2 • Published 1 year ago

@kingworldjs/static v0.0.0-experimental.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@kingworldjs/static

Plugin for kingworld for serving static folder.

Installation

bun add @kingworldjs/static

Example

import { KingWorld } from 'kingworld'
import { staticPlugin } from '@kingworldjs/static'

const app = new KingWorld()
    .use(staticPlugin)
    .listen(8080)

Config

Below is an available config for a static plugin.

path

@default "public"

Path to expose as a public path

prefix

@default '/public'

Path prefix to create a virtual mount path for the static directory

staticLimit

@defualt 1024

If total files exceed this number, the file will be handled via wildcard instead of the static route to reduce memory usage

alwaysStatic

@default boolean

If set to true, the file will always use a static path instead