DenchInterface

간략한 설명

dench(baseURL)이 반환하는 API 클라이언트 타입입니다. base URL과 HTTP 메서드별 요청 빌더 생성 함수를 제공합니다.

타입 정의

interface DenchInterface {
  baseURL: DenchHTTPURL;
  get: <T>(api?: string) => DenchGetBuilder<T>;
  post: <T>(api?: string, data?: unknown) => DenchCreateBuilder<T>;
  put: <T>(api?: string, data?: unknown) => DenchCreateBuilder<T>;
  delete: <T>(api?: string) => DenchGetBuilder<T>;
}

DenchInterface 자체에는 제너릭이 없습니다. 각 HTTP 메서드의 제너릭 T는 해당 요청에서 toJson()이 반환할 JSON 응답 타입입니다.

프로퍼티

Property	Type	Required	Description
baseURL	DenchHTTPURL	Yes	클라이언트가 사용하는 기본 URL입니다.
get	<T>(api?: string) => DenchGetBuilder<T>	Yes	GET 요청 빌더를 생성합니다.
post	<T>(api?: string, data?: unknown) => DenchCreateBuilder<T>	Yes	POST 요청 빌더를 생성합니다.
put	<T>(api?: string, data?: unknown) => DenchCreateBuilder<T>	Yes	PUT 요청 빌더를 생성합니다.
delete	<T>(api?: string) => DenchGetBuilder<T>	Yes	DELETE 요청 빌더를 생성합니다.

사용처

• dench(baseURL) 함수의 반환 타입입니다.
• get(), post(), put(), delete() 요청 빌더 생성 API를 정의합니다.

import { dench } from 'dench-fetch';
import type { DenchInterface } from 'dench-fetch';

const api: DenchInterface = dench('https://api.example.com');