Documentation: getMultilingualUrls 함수 in intlayer

설명:

getMultilingualUrls 함수는 주어진 URL에 각 지원되는 로케일을 접두사로 붙여 다국어 URL 매핑을 생성합니다. 이 함수는 절대 및 상대 URL을 모두 처리할 수 있으며, 제공된 구성이나 기본값에 따라 적절한 로케일 접두사를 적용합니다.

매개변수:

• url: string

  • 설명: 로케일로 접두사 붙일 원래 URL 문자열입니다.
  • 유형: string

• locales: Locales[]

  • 설명: 지원되는 로케일의 선택적 배열입니다. 프로젝트에 설정된 로케일로 기본값을 사용합니다.
  • 유형: Locales[]
  • 기본값: localesDefault

• defaultLocale: Locales

  • 설명: 애플리케이션의 기본 로케일입니다. 프로젝트에 설정된 기본 로케일을 사용합니다.
  • 유형: Locales
  • 기본값: defaultLocaleDefault

• prefixDefault: boolean

  • 설명: 기본 로케일에 접두사 붙일지 여부입니다. 프로젝트에 설정된 값으로 기본값을 사용합니다.
  • 유형: boolean
  • 기본값: prefixDefaultDefault

반환값:

• 유형: IConfigLocales<string>
• 설명: 각 로케일을 해당하는 다국어 URL에 매핑하는 객체입니다.

예제 사용법:

상대 URL:

import { getMultilingualUrls, Locales } from "intlayer";

getMultilingualUrls(
  "/dashboard",
  [Locales.ENGLISH, Locales.FRENCH],
  Locales.ENGLISH,
  false
);
// 출력: {
//   en: "/dashboard",
//   fr: "/fr/dashboard"
// }

절대 URL:

getMultilingualUrls(
  "https://example.com/dashboard",
  [Locales.ENGLISH, Locales.FRENCH],
  Locales.ENGLISH,
  true
);
// 출력: {
//   en: "https://example.com/en/dashboard",
//   fr: "https://example.com/fr/dashboard"
// }

에지 케이스:

• 로케일 세그먼트 없음:

  • 이 함수는 다국어 매핑을 생성하기 전에 URL에서 기존의 로케일 세그먼트를 제거합니다.

• 기본 로케일:

  • prefixDefault가 false일 때, 이 함수는 기본 로케일의 URL에 접두사를 붙이지 않습니다.

• 지원되지 않는 로케일:

  • locales 배열에 제공된 로케일만 URL 생성을 위해 고려됩니다.

애플리케이션 내 사용:

다국어 애플리케이션에서 locales와 defaultLocale으로 국제화 설정을 구성하는 것은 올바른 언어가 표시되도록 하는 데 중요합니다. 아래는 애플리케이션 설정에서 getMultilingualUrls를 사용하는 방법의 예입니다:

import { Locales, type IntlayerConfig } from "intlayer";

// 지원되는 로케일 및 기본 로케일에 대한 구성
export default {
  internationalization: {
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
    defaultLocale: Locales.ENGLISH,
  },
} satisfies IntlayerConfig;

export default config;

위의 구성은 애플리케이션이 ENGLISH, FRENCH, SPANISH를 지원되는 언어로 인식하고 ENGLISH를 기본 언어로 사용하도록 보장합니다.

이 구성을 사용하면 getMultilingualUrls 함수가 애플리케이션의 지원되는 로케일에 따라 다국어 URL 매핑을 동적으로 생성할 수 있습니다:

getMultilingualUrls(
  "/dashboard",
  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
  Locales.ENGLISH
);
// 출력:
// {
//   en: "/dashboard",
//   fr: "/fr/dashboard",
//   es: "/es/dashboard"
// }

getMultilingualUrls(
  "https://example.com/dashboard",
  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
  Locales.ENGLISH,
  true
);
// 출력:
// {
//   en: "https://example.com/en/dashboard",
//   fr: "https://example.com/fr/dashboard",
//   es: "https://example.com/es/dashboard"
// }

getMultilingualUrls를 통합함으로써 개발자들은 여러 언어에서 일관된 URL 구조를 유지할 수 있어 사용자 경험과 SEO를 향상시킬 수 있습니다.