Module "RouteFetcher"

RouteFetcher

• RouteFetcher<M>(schema: RouteSchema<M>, options?: RouteFetcherOptions): RouteFetcher<M>

• Creates a RouteFetcher instance that can be used to execute an HTTP request based on the given route schema.

  Example

  let TestRoute = await RouteFetcher(TestRouteSchema)
  let response = await TestRoute.get({
    query: {
      name: 'Simon'
    }
  })
  
  if (response.status === 200) {
    console.log(response.body.message)
  }

  Unsupported content types do not have a populated body field. Please use one of fetch's body consumption functions.

  Example

  if (response.contentType === 'application/octet-stream') {
    let buf = await response.res.arrayBuffer()
  }

  Type parameters

  • M: MethodSchemas

  Parameters

  • schema: RouteSchema<M>

    The route schema of the route to request.

  • Default value options: RouteFetcherOptions = {}

    Additional fetching options.

  Returns RouteFetcher<M>