Type Alias EndpointResponseType<Endpoint, Method, Status>

Example

import {
    defineEndpoint,
    HttpMethod,
    HttpStatus,
    type EndpointResponseType,
} from '@rest-vir/api';
import {defineShape} from 'object-shape-tester';

const usersEndpoint = defineEndpoint({
    path: '/users',
    requests: {
        [HttpMethod.Get]: {
            responses: {
                [HttpStatus.Ok]: {
                    responseData: defineShape({users: [{id: ''}]}),
                },
            },
        },
    },
});

type OkResponse = EndpointResponseType<
    (typeof usersEndpoint.requests)[HttpMethod.Get],
    HttpStatus.Ok
>;
Copy