@elysiajs/static

@elysiajs/static

Plugin for elysia for serving static folder.

Installation

bun add @elysiajs/static

Example

import { Elysia } from 'elysia'
import { staticPlugin } from '@elysiajs/static'

const app = new Elysia()
    .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

Changelog

0.2.0-beta.0 - 19 Jan 2023

Improvement:

• Using fs/promise instead of sync
• Support non blocking plugin registraiton

Change:

• Minimum requirement is now elysia >= 0.2.0-beta.0