Variable formDataShape`Const`

formDataShape: (defaultValue?: FormData) => Shape<TUnsafe<FormData>> = ...

A custom shape definition for requests that require FormData as the body.

Type Declaration

- (defaultValue?: FormData): Shape<TUnsafe<FormData>>
- Parameters
  - OptionaldefaultValue: FormData
  Returns Shape<TUnsafe<FormData>>

Example

import {defineEndpoint, formDataShape, HttpMethod, HttpStatus} from '@rest-vir/api';

const uploadEndpoint = defineEndpoint({
    path: '/upload',
    requests: {
        [HttpMethod.Post]: {
            requestData: formDataShape(),
            responses: {
                [HttpStatus.Ok]: {
                    responseData: undefined,
                },
            },
        },
    },
});

Package

@rest-vir/api