params()

함수 시그니처

params: (params: DenchURLSearchParams) => R

type DenchURLSearchParams = ConstructorParameters<typeof URLSearchParams>[0]

설명

params()는 요청 빌더 체인에서 URL query parameter 입력을 받는 API입니다.

전달할 수 있는 값은 URLSearchParams 생성자에 사용할 수 있는 값과 같습니다.

string | string[][] | Record<string, string> | URLSearchParams | undefined

예제

import { dench } from 'dench-fetch';

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

const users = await api
  .get('/users')
  .params({ page: '1', limit: '20' })
  .toJson();

문자열 query parameter도 전달할 수 있습니다.

const users = await api
  .get('/users')
  .params('?page=1&limit=20')
  .toJson();

주의사항

• params()는 0.1.0-beta.7에서 추가된 API입니다.
• 현재 구현은 전달된 값을 URLSearchParams로 변환하지만, 최종 요청 URL에는 아직 반영하지 않습니다.
• 실제 query parameter가 필요한 경우에는 이 제한이 해소되기 전까지 API 경로에 직접 query string을 포함하세요.

const users = await api
  .get('/users?page=1&limit=20')
  .toJson();