Method request

src/zodios.ts:259–287

* make a request to the api * @param config - the config to setup zodios options and parameters * @returns response validated with zod schema provided in the api description

(
    config: Path extends ZodiosPathsByMethod<Api, M>
      ? ReadonlyDeep<ZodiosRequestOptions<Api, M, Path>>
      : ReadonlyDeep<ZodiosRequestOptions<Api, M, ZodiosPathsByMethod<Api, M>>>
  )

   * @returns response validated with zod schema provided in the api description
   */
  async request<M extends Method, Path extends string>(
    config: Path extends ZodiosPathsByMethod<Api, M>
      ? ReadonlyDeep<ZodiosRequestOptions<Api, M, Path>>
      : ReadonlyDeep<ZodiosRequestOptions<Api, M, ZodiosPathsByMethod<Api, M>>>
  ): Promise<
    ZodiosResponseByPath<
      Api,
      M,
      Path extends ZodiosPathsByMethod<Api, M> ? Path : never
    >
  > {
    let conf = config as unknown as ReadonlyDeep<AnyZodiosRequestOptions>;
    const anyPlugin = this.getAnyEndpointPlugins()!;
    const endpointPlugin = this.findEnpointPlugins(conf.method, conf.url);
    conf = await anyPlugin.interceptRequest(this.api, conf);
    if (endpointPlugin) {
      conf = await endpointPlugin.interceptRequest(this.api, conf);
    }
    let response = this.axiosInstance.request({
      ...omit(conf as AnyZodiosRequestOptions, ["params", "queries"]),
      url: replacePathParams(conf),
      params: conf.queries,
    });
    if (endpointPlugin) {
      response = endpointPlugin.interceptResponse(this.api, conf, response);
    }
    response = anyPlugin.interceptResponse(this.api, conf, response);
    return (await response).data;
  }

  /**
   * make a get request to the api