Neutrino Packing Machine

    oily
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.14 • Public • Published

    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
            });
          }
        }
      }
    });

    Install

    npm i oily

    DownloadsWeekly Downloads

    15

    Version

    0.1.14

    License

    MIT

    Unpacked Size

    23.4 kB

    Total Files

    37

    Last publish

    Collaborators

    • ariesclark