JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q40262F
  • License MIT

A blazingly fast Bun.js filesystem router, with an unpleasantly smooth experience!

Package Exports

  • oily
  • oily/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (oily) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Oily

A blazingly fast Bun.js filesystem router, with
an unpleasantly smooth experience!

npm npm
GitHub issues GitHub commit activity

Installation   ·   Usage   ·   Examples   ·   Discord

Installation

Once you've got Bun.js installed, The installation is super simple, just run the following commands.

# Install Bun.js, If you haven't yet.
curl https://bun.sh/install | bash

# Use Bun's package manager to install, or you
# can use any package manager that supports Bun.js.
bun add oily

Usage

// file: ./src/index.ts
import { Oily } from "oily";

await Oily.serve({
  middleware: [
    async (request, next) => {
      // do something before.
      const response = await next();
      // do something after.

      return response;
    }
  ]
});

// now listening on port 3000.

Routes are found, by default, within the ./http/routes directory, next to the entrypoint.

// file: ./src/http/routes/foo.ts
import { Oily } from "oily";

export default Oily.route({
  methods: {
    get: {
      async handle() {
        return Response.json({
          foo: true
        });
      }
    }
  }
});