Options
All
  • Public
  • Public/Protected
  • All
Menu

A floof module. Provides endpoints and other associated request handlers for a floof server.

Hierarchy

  • FloofBall

Index

Constructors

constructor

Methods

adaptBody

  • Sets a default body parser for all requests this floofball receives.

    Parameters

    Returns FloofBall

    This FloofBall, for the sake of chaining.

after

  • Registers a new after-handler which gets run after endpoint handlers.

    Returns AfterHandler

    The newly-created after-handler.

before

  • Registers a new before-handler which gets run before any endpoint handler.

    Returns BeforeHandler

    The newly-created before-handler.

context

  • Sets a default rendering context for all requests this floofball receives.

    Parameters

    Returns FloofBall

    This FloofBall, for the sake of chaining.

delete

  • Registers a new endpoint handler for the HTTP verb DELETE.

    Parameters

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

endpoint

  • Registers a new endpoint handler for the given method and path.

    Parameters

    • method: HttpVerb

      The HTTP verb this handler should handle.

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

error

  • Registers a new error handler that gets run to handle erroneous HTTP status codes.

    Returns ErrorHandler

    The newly-created error handler.

get

  • Registers a new endpoint handler for the HTTP verb GET.

    Parameters

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

head

  • Registers a new endpoint handler for the HTTP verb HEAD.

    Parameters

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

patch

  • Registers a new endpoint handler for the HTTP verb PATCH.

    Parameters

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

plugin

post

  • Registers a new endpoint handler for the HTTP verb POST.

    Parameters

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

put

  • Registers a new endpoint handler for the HTTP verb PUT.

    Parameters

    • path: EndpointPath

      The path this handler should handle requests to.

    Returns EndpointHandler

    The newly-created endpoint handler.

Generated using TypeDoc