Documentation
    Preparing search index...

    Interface WebOptions<State>

    Options with properties relevant to templates rendered for webservers passed to FuncStacheModule methods.

    interface WebOptions<State> {
        fqModuleDirectory: string;
        path: string;
        pathParams?: Record<string, string | string[]>;
        state?: State;
    }

    Type Parameters

    • State

      An object that implements the State type is passed from the Renderer to the module files for use in creating the mustache template.

    Hierarchy (View Summary)

    Index

    Properties

    fqModuleDirectory: string

    The fully qualified location of this module file.

    path: string

    Path that the client (browser) has requested.

    pathParams?: Record<string, string | string[]>

    Parameters extracted from the request's URL path. When the template file path contains variables the value of those variables is extracted from the request's URL path. For example, if the URL is "/posts/123" and the template file path is "/posts/:id" then pathParams will have a property named id with the value "123".

    state?: State

    Optional tramp data passed to the FuncStacheModule methods from the Renderer.