UNPKG

synapse-react-client

Version:

[![npm version](https://badge.fury.io/js/synapse-react-client.svg)](https://badge.fury.io/js/synapse-react-client) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettie

15 lines 1.43 kB
import { ErrorResponse } from '@sage-bionetworks/synapse-client'; import { DefaultBodyType } from 'msw'; /** * Generates MSW handlers for asynchronous jobs. * @param requestPath the path to the service-specific asynchronous job request endpoint. * For example, `'/repo/v1/entity/:id/table/query/async/start'` * @param responsePath a function that takes the token parameter ID and returns a path to the service-specific asynchronous job response endpoint. * For example, `param => /repo/v1/entity/:id/table/query/async/get/${param}` * The generic asynchronous job retrieval handler will be generated automatically. * @param responseBody the response body, or a function that takes the request body and returns the response body * @param backendOrigin the backend origin to use for the handlers. * @param serviceSpecificEndpointResponseStatus the status code to use for the service-specific endpoint. The asynchronous job endpoint will always return 200. */ export declare function generateAsyncJobHandlers<TRequestBody = unknown, TResponseBody extends DefaultBodyType | ErrorResponse = DefaultBodyType | ErrorResponse>(requestPath: string, responsePath: (tokenParam: string) => string, responseBody: TResponseBody | ((requestBody: TRequestBody) => TResponseBody), backendOrigin?: string, serviceSpecificEndpointResponseStatus?: number): import("msw").HttpHandler[]; //# sourceMappingURL=asyncJobHandlers.d.ts.map