@bearnjs/rest
    Preparing search index...

    Interface RouterOptions

    Options for creating a Router, allowing configuration of a base prefix, middlewares, and metadata. RouterOptions

    interface RouterOptions {
        description?: string;
        middlewares?: Handler<
            Record<string, string>,
            Record<string, string>,
            JsonValue,
            JsonValue,
        >[];
        name?: string;
        prefix?: string;
    }
    Index

    Properties

    description? middlewares? name? prefix?

    Properties

    description?: string

    A description for documentation or printing purposes.

    middlewares?: Handler<
        Record<string, string>,
        Record<string, string>,
        JsonValue,
        JsonValue,
    >[]

    Middlewares to register on the router upon creation.

    name?: string

    A human-friendly name for tooling purposes.

    prefix?: string

    An optional path prefix applied when the router is mounted without an explicit path.

    Settings

    Member Visibility

    On This Page

    Properties