docs: update docs

Author: kazupon

eslint.config.ts

@@ -106,6 +106,7 @@ const config: ReturnType<typeof defineConfig> = defineConfig(
     './**/playground/**',
     './packages/h3/docs/**',
     './packages/hono/docs/**',
+    './packages/elysia/docs/**',
     'design/**'
   ]) as Linter.Config
 )

packages/elysia/docs/functions/detectLocaleFromAcceptLanguageHeader.md

@@ -0,0 +1,49 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getCookieLocale
+
+# Function: getCookieLocale()
+
+```ts
+function getCookieLocale(request, options?): Locale
+```
+
+get locale from cookie
+
+## Parameters
+
+| Parameter  | Type                  | Description                                                                                                                                                                                                                                              |
+| ---------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `request`  | `Request`             | The Request \| request                                                                                                                                                                                                                                   |
+| `options?` | `CookieLocaleOptions` | The CookieLocaleOptions \| cookie locale options, `lang` option is `en-US` as default, you must specify the language tag with the [BCP 47 syntax](https://datatracker.ietf.org/doc/html/rfc4646#section-2.1). `name` option is `i18n_locale` as default. |
+
+## Returns
+
+`Locale`
+
+The locale that resolved from cookie
+
+## Example
+
+example for Web API request on Deno:
+
+```ts
+import { getCookieLocale } from 'https://esm.sh/@intlify/utils/web'
+
+Deno.serve(
+  {
+    port: 8080
+  },
+  req => {
+    const locale = getCookieLocale(req)
+    console.log(locale) // output `Intl.Locale` instance
+    // ...
+  }
+)
+```
+
+## Throws
+
+Throws a `RangeError` if `lang` option or cookie name value are not a well-formed BCP 47 language tag.

packages/elysia/docs/functions/getCookieLocale.md

@@ -0,0 +1,46 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getHeaderLanguage
+
+# Function: getHeaderLanguage()
+
+```ts
+function getHeaderLanguage(request, options?): string
+```
+
+get language from header
+
+## Parameters
+
+| Parameter  | Type            | Description                                |
+| ---------- | --------------- | ------------------------------------------ |
+| `request`  | `Request`       | The Request \| request                     |
+| `options?` | `HeaderOptions` | The HeaderOptions \| header options object |
+
+## Returns
+
+`string`
+
+The **first language tag** of header, if header is not exists, or `*` (any language), return empty string.
+
+## Description
+
+parse header string, default `accept-language`. if you use `accept-language`, this function returns the **first language tag** of `accept-language` header.
+
+## Example
+
+example for Web API request on Deno:
+
+```ts
+import { getAcceptLanguage } from 'https://esm.sh/@intlify/utils/web'
+
+Deno.serve({
+  port: 8080,
+}, (req) => {
+  const langTag = getHeaderLanguage(req)
+  // ...
+  return new Response(`accepted language: ${langTag}`
+})
+```

packages/elysia/docs/functions/getHeaderLanguage.md

@@ -0,0 +1,46 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getHeaderLanguages
+
+# Function: getHeaderLanguages()
+
+```ts
+function getHeaderLanguages(request, options?): string[]
+```
+
+get languages from header
+
+## Parameters
+
+| Parameter  | Type            | Description                                                                                |
+| ---------- | --------------- | ------------------------------------------------------------------------------------------ |
+| `request`  | `Request`       | The Request \| request                                                                     |
+| `options?` | `HeaderOptions` | The HeaderOptions \| header options object. `name` option is `accept-language` as default. |
+
+## Returns
+
+`string`[]
+
+The array of language tags, if you use `accept-language` header and `*` (any language) or empty string is detected, return an empty array.
+
+## Description
+
+parse header string, default `accept-language` header
+
+## Example
+
+example for Web API request on Deno:
+
+```ts
+import { getHeaderLanguages } from 'https://esm.sh/@intlify/utils/web'
+
+Deno.serve({
+  port: 8080,
+}, (req) => {
+  const langTags = getHeaderLanguages(req)
+  // ...
+  return new Response(`accepted languages: ${langTags.join(', ')}`
+})
+```

packages/elysia/docs/functions/getHeaderLanguages.md

@@ -0,0 +1,51 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getHeaderLocale
+
+# Function: getHeaderLocale()
+
+```ts
+function getHeaderLocale(request, options?): Locale
+```
+
+get locale from header
+
+## Parameters
+
+| Parameter  | Type                       | Description                                                                                                                                                                                                                                                                                                  |
+| ---------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`  | `Request`                  | The Request \| request                                                                                                                                                                                                                                                                                       |
+| `options?` | `HeaderOptions` & `object` | The HeaderOptions \| header options object. `lang` option is `en-US` as default, you must specify the language tag with the [BCP 47 syntax](https://datatracker.ietf.org/doc/html/rfc4646#section-2.1). `name` option is `accept-language` as default, and `parser` option is parseDefaultHeader as default. |
+
+## Returns
+
+`Locale`
+
+The first locale that resolved from header string. if you use `accept-language` header and `*` (any language) or empty string is detected, return `en-US`.
+
+## Description
+
+wrap language tag with Intl.Locale \| locale, languages tags will be parsed from `accept-language` header as default.
+
+## Example
+
+```ts
+example for Web API request on Bun:
+
+import { getHeaderLocale } from '@intlify/utils/web'
+
+Bun.serve({
+  port: 8080,
+  fetch(req) {
+    const locale = getHeaderLocale(req)
+    // ...
+    return new Response(`accpected locale: ${locale.toString()}`)
+  },
+})
+```
+
+## Throws
+
+Throws the `RangeError` if `lang` option or header are not a well-formed BCP 47 language tag.

packages/elysia/docs/functions/getHeaderLocale.md

@@ -0,0 +1,51 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getHeaderLocales
+
+# Function: getHeaderLocales()
+
+```ts
+function getHeaderLocales(request, options?): Locale[]
+```
+
+get locales from header
+
+## Parameters
+
+| Parameter  | Type            | Description                                |
+| ---------- | --------------- | ------------------------------------------ |
+| `request`  | `Request`       | The Request \| request                     |
+| `options?` | `HeaderOptions` | The HeaderOptions \| header options object |
+
+## Returns
+
+`Locale`[]
+
+The locales that wrapped from header, if you use `accept-language` header and `*` (any language) or empty string is detected, return an empty array.
+
+## Description
+
+wrap language tags with Intl.Locale \| locale, languages tags will be parsed from `accept-language` header as default.
+
+## Example
+
+example for Web API request on Bun:
+
+```ts
+import { getHeaderLocales } from '@intlify/utils/web'
+
+Bun.serve({
+  port: 8080,
+  fetch(req) {
+    const locales = getHeaderLocales(req)
+    // ...
+    return new Response(`accpected locales: ${locales.map(locale => locale.toString()).join(', ')}`)
+  }
+})
+```
+
+## Throws
+
+Throws the `RangeError` if header are not a well-formed BCP 47 language tag.

packages/elysia/docs/functions/getHeaderLocales.md

@@ -0,0 +1,30 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getPathLocale
+
+# Function: getPathLocale()
+
+```ts
+function getPathLocale(request, options?): Locale
+```
+
+get the locale from the path
+
+## Parameters
+
+| Parameter  | Type          | Description                            |
+| ---------- | ------------- | -------------------------------------- |
+| `request`  | `Request`     | the Request \| request                 |
+| `options?` | `PathOptions` | the PathOptions \| path options object |
+
+## Returns
+
+`Locale`
+
+The locale that resolved from path
+
+## Throws
+
+Throws the `RangeError` if the language in the path, that is not a well-formed BCP 47 language tag.

packages/elysia/docs/functions/getPathLocale.md

@@ -0,0 +1,30 @@
+[**@intlify/elysia**](../index.md)
+
+---
+
+[@intlify/elysia](../index.md) / getQueryLocale
+
+# Function: getQueryLocale()
+
+```ts
+function getQueryLocale(request, options?): Locale
+```
+
+get the locale from the query
+
+## Parameters
+
+| Parameter  | Type           | Description                                                                                                   |
+| ---------- | -------------- | ------------------------------------------------------------------------------------------------------------- |
+| `request`  | `Request`      | the Request \| request                                                                                        |
+| `options?` | `QueryOptions` | The QueryOptions \| query options, `lang` option is `en-US` as default, `name` option is `locale` as default. |
+
+## Returns
+
+`Locale`
+
+The locale that resolved from query
+
+## Throws
+
+Throws the `RangeError` if the language in the query, that is not a well-formed BCP 47 language tag.