Options
All
  • Public
  • Public/Protected
  • All
Menu
     

Interface Base

A collection of Data-Requests for a BaseEndpoint. A BaseEndpoint represents a Namespace for any number of related Endpoints.

Examples:

// "User" is the BaseEndpoint ("/user")
User: {
    Actions: {
         // Resolves to "/user/[0-9]+/settings"
         Settings: new RouteDB({
             // Merge the parameters of the Parent The path requires the "uid" parameter
             // Merge the parameters of the Parent The path requires the "uid" parameter
             Merge: true,
             ...
         }),
         // Resolves to "/user/[0-9]+"
         "/": new RouteDB({
             Scheme: '/:uid', // The path requires the "uid" parameter
             ...
         }),
    },
    Errors: {
        // Denies "/auth" & "/auth/"
        BAD_REQ: ['/']
    },
}

Hierarchy

Index

Properties

Properties

Actions

Where each related Endpoint is defined.

Errors

Errors: CLRouteER

A plain-object used to define any list paths that are invalid and the HTTP_MSG that should be sent to the end-user.