Documentation
    Preparing search index...

    Interface IProps

    Route facts the simulator needs to build its 400 error: the host, the path, and the method.

    contentType is the content type of the route's success response, which the generated code answers with; the simulated 400 is JSON whatever it is.

    contracts/common.md#principled-implementation The host, path, and method identify the request in the error, and the content type describes the success response of the generated function, which the generated code answers with.

    contracts/common.md#clear-and-simple-design A four-field record with no behavior.

    contracts/common.md#prohibited-implementation-shortcuts The values are supplied by the generated SDK for its own route.

    contracts/common.md#meaningful-documentation The comment says what each part is used for, with the contentType member documenting when it is null.

    interface IProps {
        contentType: string | null;
        host: string;
        method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
        path: string;
    }
    Index
    contentType host method path
    contentType: string | null

    Content type of the route's success response, null for one without a body such as HEAD's. The simulated 400 is JSON whatever it is, as the server's is.

    host: string
    method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
    path: string

    Settings
    Member Visibility

    On This Page
    Properties