@intlayer/docs 7.0.7 → 7.0.8

package/docs/id/packages/intlayer/getEnumeration.md

@@ -0,0 +1,159 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getEnumeration | intlayer
+description: Lihat cara menggunakan fungsi getEnumeration untuk paket intlayer
+keywords:
+  - getEnumeration
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getEnumeration
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inisialisasi riwayat
+---
+
+# Dokumentasi: Fungsi `getEnumeration` di `intlayer`
+
+## Deskripsi
+
+Fungsi `getEnumeration` mengambil konten yang sesuai dengan kuantitas tertentu berdasarkan kondisi yang telah ditentukan dalam objek enumerasi. Kondisi-kondisi tersebut didefinisikan sebagai kunci, dan prioritasnya ditentukan oleh urutan mereka dalam objek.
+
+## Parameter
+
+- `enumerationContent: QuantityContent<Content>`
+  - **Deskripsi**: Sebuah objek di mana kunci mewakili kondisi (misalnya, `<=`, `<`, `>=`, `=`) dan nilai mewakili konten yang sesuai. Urutan kunci menentukan prioritas pencocokan mereka.
+  - **Tipe**: `QuantityContent<Content>`
+    - `Content` dapat berupa tipe apa pun.
+
+- `quantity: number`
+  - **Deskripsi**: Nilai numerik yang digunakan untuk mencocokkan dengan kondisi dalam `enumerationContent`.
+  - **Tipe**: `number`
+
+## Mengembalikan
+
+- **Tipe**: `Content`
+- **Deskripsi**: Konten yang sesuai dengan kondisi pertama yang cocok dalam `enumerationContent`. Jika tidak ditemukan kecocokan, maka akan ditangani sesuai dengan implementasi (misalnya, error atau konten fallback).
+
+## Contoh Penggunaan
+
+### Penggunaan Dasar
+
+```typescript codeFormat="typescript"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<=-2.3": "Anda memiliki kurang dari -2.3",
+    "<1": "Anda memiliki kurang dari satu",
+    "2": "Anda memiliki dua",
+    ">=3": "Anda memiliki tiga atau lebih",
+  },
+  2
+);
+
+console.log(content); // Output: "Anda memiliki dua"
+```
+
+```javascript codeFormat="esm"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<1": "Anda memiliki kurang dari satu",
+    "2": "Anda memiliki dua",
+    ">=3": "Anda memiliki tiga atau lebih",
+  },
+  2
+);
+
+console.log(content); // Output: "Anda memiliki dua"
+```
+
+```javascript codeFormat="commonjs"
+const { getEnumeration } = require("intlayer");
+
+const content = getEnumeration(
+  {
+    "<1": "Anda memiliki kurang dari satu",
+    "2": "Anda memiliki dua",
+    ">=3": "Anda memiliki tiga atau lebih",
+  },
+  2
+);
+
+console.log(content); // Output: "Anda memiliki dua"
+```
+
+### Prioritas Kondisi
+
+```typescript codeFormat="typescript"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<4": "Anda memiliki kurang dari empat",
+    "2": "Anda memiliki dua",
+  },
+  2
+);
+
+console.log(content); // Output: "Anda memiliki kurang dari empat"
+```
+
+```javascript codeFormat="esm"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<4": "Anda memiliki kurang dari empat",
+    "2": "Anda memiliki dua",
+  },
+  2
+);
+
+console.log(content); // Output: "Anda memiliki kurang dari empat"
+```
+
+```javascript codeFormat="commonjs"
+const { getEnumeration } = require("intlayer");
+
+const content = getEnumeration(
+  {
+    "<4": "Anda memiliki kurang dari empat",
+    "2": "Anda memiliki dua",
+  },
+  2
+);
+
+console.log(content); // Output: "Anda memiliki kurang dari empat"
+```
+
+## Kasus Tepi
+
+- **Tidak Ada Kondisi yang Cocok:**
+  - Jika tidak ada kondisi yang cocok dengan kuantitas yang diberikan, fungsi akan mengembalikan `undefined` atau menangani skenario default/fallback secara eksplisit.
+
+- **Kondisi Ambigu:**
+  - Jika kondisi saling tumpang tindih, kondisi yang pertama cocok (berdasarkan urutan objek) yang akan diutamakan.
+
+- **Kunci Tidak Valid:**
+  - Fungsi mengasumsikan bahwa semua kunci dalam `enumerationContent` valid dan dapat diurai sebagai kondisi. Kunci yang tidak valid atau format yang salah dapat menyebabkan perilaku yang tidak terduga.
+
+- **Penegakan TypeScript:**
+  - Fungsi memastikan bahwa tipe `Content` konsisten di semua kunci, memungkinkan keamanan tipe pada konten yang diambil.
+
+## Catatan
+
+- Utilitas `findMatchingCondition` digunakan untuk menentukan kondisi yang sesuai berdasarkan kuantitas yang diberikan.

package/docs/id/packages/intlayer/getHTMLTextDir.md

@@ -0,0 +1,122 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getHTMLTextDir | intlayer
+description: Lihat cara menggunakan fungsi getHTMLTextDir untuk paket intlayer
+keywords:
+  - getHTMLTextDir
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getHTMLTextDir
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Riwayat awal
+---
+
+# Dokumentasi: Fungsi `getHTMLTextDir` di `intlayer`
+
+## Deskripsi
+
+Fungsi `getHTMLTextDir` menentukan arah teks (`ltr`, `rtl`, atau `auto`) berdasarkan locale yang diberikan. Fungsi ini dirancang untuk membantu pengembang mengatur atribut `dir` di HTML agar teks dapat ditampilkan dengan benar.
+
+## Parameter
+
+- `locale?: Locales`
+  - **Deskripsi**: String locale (misalnya, `Locales.ENGLISH`, `Locales.ARABIC`) yang digunakan untuk menentukan arah teks.
+  - **Tipe**: `Locales` (opsional)
+
+## Mengembalikan
+
+- **Tipe**: `Dir` (`'ltr' | 'rtl' | 'auto'`)
+- **Deskripsi**: Arah teks yang sesuai dengan locale:
+  - `'ltr'` untuk bahasa yang dibaca dari kiri ke kanan.
+  - `'rtl'` untuk bahasa yang dibaca dari kanan ke kiri.
+  - `'auto'` jika locale tidak dikenali.
+
+## Contoh Penggunaan
+
+### Menentukan Arah Teks
+
+```typescript codeFormat="typescript"
+import { getHTMLTextDir } from "intlayer";
+
+getHTMLTextDir(Locales.ENGLISH); // Output: "ltr"
+getHTMLTextDir(Locales.FRENCH); // Output: "ltr"
+getHTMLTextDir(Locales.ARABIC); // Output: "rtl"
+```
+
+```javascript codeFormat="esm"
+import { getHTMLTextDir } from "intlayer";
+
+getHTMLTextDir(Locales.ENGLISH); // Output: "ltr"
+getHTMLTextDir(Locales.FRENCH); // Output: "ltr"
+getHTMLTextDir(Locales.ARABIC); // Output: "rtl"
+```
+
+```javascript codeFormat="commonjs"
+const { getHTMLTextDir } = require("intlayer");
+
+// Mendapatkan arah teks berdasarkan locale
+getHTMLTextDir(Locales.ENGLISH); // Output: "ltr"
+getHTMLTextDir(Locales.FRENCH); // Output: "ltr"
+getHTMLTextDir(Locales.ARABIC); // Output: "rtl"
+```
+
+## Kasus Tepi
+
+- **Tidak Ada Locale yang Diberikan:**
+  - Fungsi mengembalikan `'auto'` ketika `locale` adalah `undefined`.
+
+- **Locale Tidak Dikenali:**
+  - Untuk locale yang tidak dikenali, fungsi akan default ke `'auto'`.
+
+## Penggunaan dalam Komponen:
+
+Fungsi `getHTMLTextDir` dapat digunakan untuk mengatur atribut `dir` secara dinamis dalam dokumen HTML agar teks dapat dirender dengan benar berdasarkan locale.
+
+```tsx codeFormat="typescript"
+import type { FC } from "react";
+import { getHTMLTextDir, type Locales } from "intlayer";
+
+export const HTMLLayout: FC<PropsWithChildren<{ locale: Locales }>> = ({
+  children,
+  locale,
+}) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+```jsx codeFormat="esm"
+import { getHTMLTextDir } from "intlayer";
+
+const HTMLLayout = ({ children, locale }) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+```jsx codeFormat="commonjs"
+const { getHTMLTextDir } = require("intlayer");
+
+const HTMLLayout = ({ children, locale }) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+Dalam contoh di atas, atribut `dir` diatur secara dinamis berdasarkan locale.

package/docs/id/packages/intlayer/getLocaleLang.md

@@ -0,0 +1,81 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getLocaleLang | intlayer
+description: Lihat cara menggunakan fungsi getLocaleLang untuk paket intlayer
+keywords:
+  - getLocaleLang
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getLocaleLang
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inisialisasi riwayat
+---
+
+# Dokumentasi: Fungsi `getLocaleLang` di `intlayer`
+
+## Deskripsi
+
+Fungsi `getLocaleLang` mengekstrak kode bahasa dari string locale. Fungsi ini mendukung locale dengan atau tanpa kode negara. Jika locale tidak diberikan, secara default akan mengembalikan string kosong.
+
+## Parameter
+
+- `locale?: Locales`
+  - **Deskripsi**: String locale (misalnya, `Locales.ENGLISH_UNITED_STATES`, `Locales.FRENCH_CANADA`) dari mana kode bahasa diekstrak.
+  - **Tipe**: `Locales` (opsional)
+
+## Mengembalikan
+
+- **Tipe**: `string`
+- **Deskripsi**: Kode bahasa yang diekstrak dari locale. Jika locale tidak diberikan, fungsi mengembalikan string kosong (`''`).
+
+## Contoh Penggunaan
+
+### Mengekstrak Kode Bahasa:
+
+```typescript codeFormat="typescript"
+import { getLocaleLang, Locales } from "intlayer";
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // Output: "en"
+getLocaleLang(Locales.ENGLISH); // Output: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // Output: "fr"
+getLocaleLang(Locales.FRENCH); // Output: "fr"
+```
+
+```javascript codeFormat="esm"
+import { getLocaleLang } from "intlayer";
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // Output: "en"
+getLocaleLang(Locales.ENGLISH); // Output: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // Output: "fr"
+getLocaleLang(Locales.FRENCH); // Output: "fr"
+```
+
+```javascript codeFormat="commonjs"
+const { getLocaleLang } = require("intlayer");
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // Output: "en"
+getLocaleLang(Locales.ENGLISH); // Output: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // Output: "fr"
+getLocaleLang(Locales.FRENCH); // Output: "fr"
+```
+
+## Kasus Tepi
+
+- **Tidak Ada Locale yang Diberikan:**
+  - Fungsi mengembalikan string kosong ketika `locale` adalah `undefined`.
+
+- **String Locale yang Rusak:**
+  - Jika `locale` tidak mengikuti format `language-country` (misalnya, `Locales.ENGLISH-US`), fungsi akan dengan aman mengembalikan bagian sebelum `'-'` atau seluruh string jika tidak ada `'-'`.

package/docs/id/packages/intlayer/getLocaleName.md

@@ -0,0 +1,119 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getLocaleName | intlayer
+description: Lihat cara menggunakan fungsi getLocaleName untuk paket intlayer
+keywords:
+  - getLocaleName
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getLocaleName
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inisialisasi riwayat
+---
+
+# Dokumentasi: Fungsi `getLocaleName` di `intlayer`
+
+## Deskripsi
+
+Fungsi `getLocaleName` mengembalikan nama lokal dari locale tertentu (`targetLocale`) dalam locale tampilan (`displayLocale`). Jika `targetLocale` tidak diberikan, fungsi ini mengembalikan nama dari `displayLocale` dalam bahasanya sendiri.
+
+## Parameter
+
+- `displayLocale: Locales`
+  - **Deskripsi**: Locale di mana nama dari target locale akan ditampilkan.
+  - **Tipe**: Enum atau string yang mewakili locale yang valid.
+
+- `targetLocale?: Locales`
+  - **Deskripsi**: Locale yang namanya akan dilokalkan.
+  - **Tipe**: Opsional. Enum atau string yang mewakili locale yang valid.
+
+## Pengembalian
+
+- **Tipe**: `string`
+- **Deskripsi**: Nama lokal dari `targetLocale` dalam `displayLocale`, atau nama `displayLocale` itu sendiri jika `targetLocale` tidak diberikan. Jika tidak ditemukan terjemahan, akan mengembalikan `"Unknown locale"`.
+
+## Contoh Penggunaan
+
+```typescript codeFormat="typescript"
+import { Locales, getLocaleName } from "intlayer";
+
+getLocaleName(Locales.ENGLISH); // Output: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Output: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Output: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Output: "English"
+
+getLocaleName(Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Output: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Output: "French"
+
+getLocaleName(Locales.CHINESE); // Output: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // Output: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Output: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Output: "Chinese"
+
+getLocaleName("unknown-locale"); // Output: "Unknown locale"
+```
+
+```javascript codeFormat="esm"
+import { Locales, getLocaleName } from "intlayer";
+
+getLocaleName(Locales.ENGLISH); // Output: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Output: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Output: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Output: "English"
+
+getLocaleName(Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Output: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Output: "French"
+
+getLocaleName(Locales.CHINESE); // Output: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // Output: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Output: "Chino"
+javascript codeFormat="esm"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Output: "Chinese"
+
+getLocaleName("unknown-locale"); // Output: "Unknown locale"
+```
+
+```javascript codeFormat="commonjs"
+const { Locales, getLocaleName } = require("intlayer");
+
+getLocaleName(Locales.ENGLISH); // Output: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Output: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Output: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Output: "English"
+
+getLocaleName(Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Output: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Output: "French"
+
+getLocaleName(Locales.CHINESE); // Output: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // Output: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Output: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Output: "Chinese"
+
+getLocaleName("unknown-locale"); // Output: "Unknown locale"
+```
+
+## Kasus Tepi
+
+- **Tidak ada `targetLocale` yang diberikan:**
+  - Fungsi secara default mengembalikan nama dari `displayLocale` itu sendiri.
+- **Terjemahan yang hilang:**
+  - Jika `localeNameTranslations` tidak berisi entri untuk `targetLocale` atau `displayLocale` tertentu, fungsi akan kembali ke `ownLocalesName` atau mengembalikan `"Unknown locale"`.