fix: type errors (#66)

* fix: type errors

* fix: typo

Author: kazupon

deno/README.md

@@ -32,47 +32,16 @@ yarn add @intlify/utils
 pnpm add @intlify/utils
 ```
 
-<details>
-  <summary>Using Edge Releases</summary>
-
-If you are directly using `@intlify/utils` as a dependency:
-
-```json
-{
-  "dependencies": {
-    "@intlify/utils": "npm:@intlify/utils-edge@latest"
-  }
-}
-```
-
-**Note:** Make sure to recreate lockfile and `node_modules` after reinstall to avoid hoisting issues.
-
-</details>
-
 ### 🦕 Deno
 
-You can install via `import`.
-
-in your code:
-
-<!-- eslint-skip -->
-
-```ts
-/**
- * you can install via other CDN URL such as skypack,
- * or, you can also use import maps
- * https://docs.deno.com/runtime/manual/basics/import_maps
- */
-import { ... } from 'https://deno.land/x/intlify_utils/mod.ts'
-
-// something todo
-// ...
+```sh
+deno add jsr:@intlify/utils
 ```
 
 ### 🥟 Bun
 
 ```sh
-bun install @intlify/utils
+bun add @intlify/utils
 ```
 
 ### 🌍 Browser
@@ -92,20 +61,6 @@ in your HTML:
 </script>
 ```
 
-<details>
-  <summary>Using Edge Releases</summary>
-
-<!-- eslint-skip -->
-
-```ts
-import { isLocale } from 'https://esm.sh/@intlify/utils-edge'
-
-// something todo
-// ...
-```
-
-</details>
-
 ## 🍭 Playground
 
 You can play the below examples:
@@ -119,59 +74,9 @@ You can play the below examples:
 - 🌍 [Browser](https://github.com/intlify/utils/tree/main/examples/browser):
   `npm run play:browser`
 
-## 🔨 Utilities
-
-### Common
-
-- `isLocale`
-- `toLocale`
-- `parseAcceptLanguage`
-- `validateLangTag`
-- `normalizeLanguageName`
-
-You can do `import { ... } from '@intlify/utils'` the above utilities
-
-### Navigator
-
-- `getNavigatorLocales`
-- `getNavigatorLocale`
-
-You can do `import { ... } from '@intlify/utils'` the above utilities
-
-<!-- eslint-disable markdown/no-missing-label-refs -->
-
-> [!NOTE]
-> for Node.js You need to do `import { ... } from '@intlify/utils/node'`
-
-<!-- eslint-enable markdown/no-missing-label-refs -->
-
-### HTTP
-
-- `getHeaderLanguages`
-- `getHeaderLanguage`
-- `getHeaderLocales`
-- `getHeaderLocale`
-- `getCookieLocale`
-- `setCookieLocale`
-- `getPathLocale`
-- `getQueryLocale`
-- `tryHeaderLocales`
-- `tryHeaderLocale`
-- `tryCookieLocale`
-- `tryPathLocale`
-- `tryQueryLocale`
-
-The about utilities functions accept Web APIs such as [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) and [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) that is supported by JS environments (such as Deno, Bun, and Browser)
-
-#### Specialized environments
-
-If you will use Node.js and H3, You can do `import { ... } from '@intlify/utils/{ENV}'` the above utilities.
-
-The namespace `{ENV}` is one of the following:
+## 🤝 API
 
-- `node`: accept `IncomingMessage` and `Outgoing` by Node.js [http](https://nodejs.org/api/http.html) module
-- `h3`: accept `H3Event` by HTTP framework [h3](https://github.com/unjs/h3)
-- `hono`: accept `Context` by edge-side web framework [hono](https://github.com/honojs/hono)
+See the [API docs](./docs/index.md)
 
 ## 🙌 Contributing guidelines
 

deno/http.ts

@@ -16,7 +16,7 @@ import {
 
 import type { PathLanguageParser } from './shared.ts'
 // import type { CookieSerializeOptions } from 'cookie-es'
-// NOTE: This is a copy of the type definition from `cookie-es` package, we want to avoid building error for this type definition ...
+// NOTE(kazupon): This is a copy of the type definition from `cookie-es` package, we want to avoid building error for this type definition ...
 
 interface CookieSerializeOptions {
   /**
@@ -219,9 +219,9 @@ export function validateLocale(locale: string | Intl.Locale): void {
  *
  * @returns The array of {@linkcode Intl.Locale} objects
  */
-export function mapToLocaleFromLanguageTag(
-  getter: (...args: unknown[]) => string[],
-  ...args: unknown[]
+export function mapToLocaleFromLanguageTag<T extends unknown[]>(
+  getter: (...args: T) => string[],
+  ...args: T
 ): Intl.Locale[] {
   return Reflect.apply(getter, null, args).map(lang => getLocaleWithGetter(() => lang))
 }

deno/index.ts

@@ -1,3 +1,16 @@
+/**
+ * `@intlify/utils` default module entry.
+ *
+ * `@inlityf/utils` will export javascript runtime agnostic utility functions and types.
+ *
+ * @example
+ * ```ts
+ * import { parseAcceptLanguage, isLocale, getHeaderLocale } from '@intlify/utils'
+ * ```
+ *
+ * @module default
+ */
+
 /**
  * @author kazuya kawaguchi (a.k.a. kazupon)
  * @license MIT

deno/web.ts

@@ -113,7 +113,6 @@ export function getHeaderLanguage(request: Request, options: HeaderOptions = {})
  * @returns The locales that wrapped from header, if you use `accept-language` header and `*` (any language) or empty string is detected, return an empty array.
  */
 export function getHeaderLocales(request: Request, options: HeaderOptions = {}): Intl.Locale[] {
-  // @ts-expect-error -- FIXME: this type error needs to be fixed
   return mapToLocaleFromLanguageTag(getHeaderLanguages, request, options)
 }
 

src/h3.ts

@@ -125,7 +125,6 @@ export function getHeaderLanguage(event: H3Event, options: HeaderOptions = {}):
  * @returns The locales that wrapped from header, if you use `accept-language` header and `*` (any language) or empty string is detected, return an empty array.
  */
 export function getHeaderLocales(event: H3Event, options: HeaderOptions = {}): Intl.Locale[] {
-  // @ts-expect-error -- FIXME: this type error needs to be fixed
   return mapToLocaleFromLanguageTag(getHeaderLanguages, event, options)
 }
 

src/hono.ts

@@ -118,7 +118,6 @@ export function getHeaderLanguage(context: Context, options: HeaderOptions = {})
  * @returns Some locales that wrapped from header, if you use `accept-language` header and `*` (any language) or empty string is detected, return an empty array.
  */
 export function getHeaderLocales(context: Context, options: HeaderOptions = {}): Intl.Locale[] {
-  // @ts-expect-error -- FIXME: this type error needs to be fixed
   return mapToLocaleFromLanguageTag(getHeaderLanguages, context, options)
 }
 

src/http.ts

@@ -16,7 +16,7 @@ import {
 
 import type { PathLanguageParser } from './shared.ts'
 // import type { CookieSerializeOptions } from 'cookie-es'
-// NOTE: This is a copy of the type definition from `cookie-es` package, we want to avoid building error for this type definition ...
+// NOTE(kazupon): This is a copy of the type definition from `cookie-es` package, we want to avoid building error for this type definition ...
 
 interface CookieSerializeOptions {
   /**
@@ -219,9 +219,9 @@ export function validateLocale(locale: string | Intl.Locale): void {
  *
  * @returns The array of {@linkcode Intl.Locale} objects
  */
-export function mapToLocaleFromLanguageTag(
-  getter: (...args: unknown[]) => string[],
-  ...args: unknown[]
+export function mapToLocaleFromLanguageTag<T extends unknown[]>(
+  getter: (...args: T) => string[],
+  ...args: T
 ): Intl.Locale[] {
   return Reflect.apply(getter, null, args).map(lang => getLocaleWithGetter(() => lang))
 }

src/index.ts

@@ -1,7 +1,7 @@
 /**
  * `@intlify/utils` default module entry.
  *
- * `@inlityf/utils` will export javascript runtime agnostic utility functions and types.
+ * `@intlify/utils` will export javascript runtime agnostic utility functions and types.
  *
  * @example
  * ```ts

src/node.ts

@@ -132,7 +132,6 @@ export function getHeaderLocales(
   request: IncomingMessage,
   options: HeaderOptions = {}
 ): Intl.Locale[] {
-  // @ts-expect-error -- FIXME: this type error needs to be fixed
   return mapToLocaleFromLanguageTag(getHeaderLanguages, request, options)
 }
 

src/web.ts

@@ -113,7 +113,6 @@ export function getHeaderLanguage(request: Request, options: HeaderOptions = {})
  * @returns The locales that wrapped from header, if you use `accept-language` header and `*` (any language) or empty string is detected, return an empty array.
  */
 export function getHeaderLocales(request: Request, options: HeaderOptions = {}): Intl.Locale[] {
-  // @ts-expect-error -- FIXME: this type error needs to be fixed
   return mapToLocaleFromLanguageTag(getHeaderLanguages, request, options)
 }