문서: intlayer의 getPrefix 함수

getPrefix(
  locale: Locales,               // 필수
  options?: {                    // 선택적
    defaultLocale?: Locales;
    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
  }
): GetPrefixResult

type GetPrefixResult = {
  prefix: string;   // 예: 'fr/' 또는 ''
  localePrefix?: Locale; // 예: 'fr' 또는 undefined
}

import { getPrefix, Locales } from "intlayer";

// prefix-all: 항상 prefix를 반환
getPrefix(Locales.ENGLISH, {
  mode: "prefix-all",
  defaultLocale: Locales.ENGLISH,
});
// 반환: { prefix: '/en', localePrefix: 'en' }

// prefix-no-default: 로케일이 기본값과 일치할 때는 prefix 없음
getPrefix(Locales.ENGLISH, {
  mode: "prefix-no-default",
  defaultLocale: Locales.ENGLISH,
});
// 반환: { prefix: '', localePrefix: undefined }

javascript;
// prefix-no-default: 기본 로케일과 다를 경우 접두사를 반환합니다.
getPrefix(Locales.FRENCH, {
  mode: "prefix-no-default",
  defaultLocale: Locales.ENGLISH,
});
// 반환값: { prefix: 'fr/', localePrefix: 'fr' }

// no-prefix & search-params: 절대 접두사를 반환하지 않습니다.
getPrefix(Locales.ENGLISH, { mode: "no-prefix" });
// 반환값: { prefix: '', localePrefix: undefined }

getPrefix(Locales.ENGLISH, { mode: "search-params" });
// 반환값: { prefix: '', localePrefix: undefined }

import { getPrefix, Locales } from "intlayer";

// 특정 로케일에 적합한 접두사를 사용하여 URL을 생성합니다.
const locale = Locales.FRENCH;
const { prefix, localePrefix } = getPrefix(locale, {
  defaultLocale: Locales.ENGLISH,
  mode: "prefix-no-default",
});

typescript;
// 경로 구성을 위한 prefix 사용
const url1 = `/${prefix}about`.replace(/\/+/g, "/");
// 결과: "/fr/about"

// locale 식별을 위한 localePrefix 사용
console.log(`현재 로케일: ${localePrefix}`);
// 출력: "현재 로케일: fr"

type GetPrefixResult = {
  prefix: string; // 슬래시가 포함된 경로 접두사 (예: 'fr/' 또는 '')
  localePrefix?: Locale; // 슬래시 없이 로케일 식별자 (예: 'fr' 또는 undefined)
};

function getPrefix(
  locale: Locales,
  options?: {
    defaultLocale?: Locales;
    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
  }
): GetPrefixResult;