feat: docs use typedoc, types

docs/.vitepress/config.ts

@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress'
+import typedocSidebar from '../api/typedoc-sidebar.json'
 
 const base = '/conversion-library/'
 
@@ -38,7 +39,10 @@ export default defineConfig({
     ],
 
     sidebar: [
-      { text: 'decimal conversion', link: '/api/decimal-conversion' }
+      {
+        text: 'API',
+        items: typedocSidebar,
+      },
     ],
 
     socialLinks: [

docs/api/functions/binaryToDecimal.md

@@ -0,0 +1,31 @@
+[conversion-library](../index.md) / binaryToDecimal
+
+# Function: binaryToDecimal()
+
+```ts
+function binaryToDecimal(str: string): number
+```
+
+binary to decimal
+
+## Parameters
+
+• **str**: `string`
+
+Enter a value of string type
+
+## Returns
+
+`number`
+
+Return the corresponding number
+
+## Example
+
+```ts
+binaryToDecimal('1010') // 10
+```
+
+## Defined in
+
+[decimalAndBinary.ts:51](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndBinary.ts#L51)

docs/api/functions/decimalToBinary.md

@@ -0,0 +1,31 @@
+[conversion-library](../index.md) / decimalToBinary
+
+# Function: decimalToBinary()
+
+```ts
+function decimalToBinary(num: number): string
+```
+
+decimal to binary
+
+## Parameters
+
+• **num**: `number`
+
+Enter a value of number type
+
+## Returns
+
+`string`
+
+Return the corresponding binary
+
+## Example
+
+```ts
+decimalToBinary(10) // '1010'
+```
+
+## Defined in
+
+[decimalAndBinary.ts:14](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndBinary.ts#L14)

docs/api/functions/decimalToOtherBase.md

@@ -0,0 +1,35 @@
+[conversion-library](../index.md) / decimalToOtherBase
+
+# Function: decimalToOtherBase()
+
+```ts
+function decimalToOtherBase(num: number, base: number): string
+```
+
+decimal to other base
+
+## Parameters
+
+• **num**: `number`
+
+Enter a value of number type
+
+• **base**: `number`
+
+Enter a value of number type
+
+## Returns
+
+`string`
+
+Return the corresponding string
+
+## Example
+
+```ts
+decimalToOtherBase(10, 2) // '1010'
+```
+
+## Defined in
+
+[decimalAndOtherBase.ts:17](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndOtherBase.ts#L17)

docs/api/functions/otherBaseToDecimal.md

@@ -0,0 +1,35 @@
+[conversion-library](../index.md) / otherBaseToDecimal
+
+# Function: otherBaseToDecimal()
+
+```ts
+function otherBaseToDecimal(str: string, base: number): number
+```
+
+other base to decimal
+
+## Parameters
+
+• **str**: `string`
+
+Enter a value of string type
+
+• **base**: `number`
+
+Enter a value of number type
+
+## Returns
+
+`number`
+
+Return the corresponding number
+
+## Example
+
+```ts
+decimalToOtherBase('1010', 2) // 10
+```
+
+## Defined in
+
+[decimalAndOtherBase.ts:60](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndOtherBase.ts#L60)

docs/api/functions/otherToTen.md

@@ -0,0 +1,35 @@
+[conversion-library](../index.md) / otherToTen
+
+# Function: otherToTen()
+
+```ts
+function otherToTen(str: string, base: number): number
+```
+
+other base to decimal
+
+## Parameters
+
+• **str**: `string`
+
+Enter a value of string type
+
+• **base**: `number`
+
+Enter a value of number type
+
+## Returns
+
+`number`
+
+Return the corresponding number
+
+## Example
+
+```ts
+decimalToOtherBase('1010', 2) // 10
+```
+
+## Defined in
+
+[decimalAndOtherBase.ts:89](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndOtherBase.ts#L89)

docs/api/functions/tenToOther.md

@@ -0,0 +1,35 @@
+[conversion-library](../index.md) / tenToOther
+
+# Function: tenToOther()
+
+```ts
+function tenToOther(num: number, base: number): string
+```
+
+decimal to other base
+
+## Parameters
+
+• **num**: `number`
+
+Enter a value of number type
+
+• **base**: `number`
+
+Enter a value of number type
+
+## Returns
+
+`string`
+
+Return the corresponding string
+
+## Example
+
+```ts
+decimalToOtherBase(10, 2) // '1010'
+```
+
+## Defined in
+
+[decimalAndOtherBase.ts:44](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndOtherBase.ts#L44)

docs/api/functions/tenToTwo.md

@@ -0,0 +1,31 @@
+[conversion-library](../index.md) / tenToTwo
+
+# Function: tenToTwo()
+
+```ts
+function tenToTwo(num: number): string
+```
+
+decimal to binary
+
+## Parameters
+
+• **num**: `number`
+
+Enter a value of number type
+
+## Returns
+
+`string`
+
+Return the corresponding binary
+
+## Example
+
+```ts
+decimalToBinary(10) // '1010'
+```
+
+## Defined in
+
+[decimalAndBinary.ts:36](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndBinary.ts#L36)

docs/api/functions/twoToTen.md

@@ -0,0 +1,31 @@
+[conversion-library](../index.md) / twoToTen
+
+# Function: twoToTen()
+
+```ts
+function twoToTen(str: string): number
+```
+
+binary to decimal
+
+## Parameters
+
+• **str**: `string`
+
+Enter a value of string type
+
+## Returns
+
+`number`
+
+Return the corresponding number
+
+## Example
+
+```ts
+binaryToDecimal('1010') // 10
+```
+
+## Defined in
+
+[decimalAndBinary.ts:74](https://github.com/fxss5201/conversion-library/blob/7986b4281d32fb392b20396e877bb0afeec7e5dc/lib/decimal-conversion/decimalAndBinary.ts#L74)

docs/api/index.md

@@ -1 +1,12 @@
-# api methods
+# conversion-library
+
+## decimal-conversion
+
+- [binaryToDecimal](functions/binaryToDecimal.md)
+- [decimalToBinary](functions/decimalToBinary.md)
+- [decimalToOtherBase](functions/decimalToOtherBase.md)
+- [otherBaseToDecimal](functions/otherBaseToDecimal.md)
+- [otherToTen](functions/otherToTen.md)
+- [tenToOther](functions/tenToOther.md)
+- [tenToTwo](functions/tenToTwo.md)
+- [twoToTen](functions/twoToTen.md)

docs/api/typedoc-sidebar.json

@@ -0,0 +1 @@
+[{"text":"decimal-conversion","collapsed":true,"items":[{"text":"binaryToDecimal","link":"/api/functions/binaryToDecimal.md"},{"text":"decimalToBinary","link":"/api/functions/decimalToBinary.md"},{"text":"decimalToOtherBase","link":"/api/functions/decimalToOtherBase.md"},{"text":"otherBaseToDecimal","link":"/api/functions/otherBaseToDecimal.md"},{"text":"otherToTen","link":"/api/functions/otherToTen.md"},{"text":"tenToOther","link":"/api/functions/tenToOther.md"},{"text":"tenToTwo","link":"/api/functions/tenToTwo.md"},{"text":"twoToTen","link":"/api/functions/twoToTen.md"}]}]

lib/decimal-conversion/decimalAndBinary.ts

@@ -1,3 +1,16 @@
+/**
+ * decimal to binary
+ * 
+ * @group decimal-conversion
+ *
+ * @param num - Enter a value of number type
+ * @returns Return the corresponding binary
+ * 
+ * @example
+ * ```ts
+ * decimalToBinary(10) // '1010'
+ * ```
+ */
 export function decimalToBinary (num: number): string {
   let res = ''
   while (num > 0) {
@@ -7,8 +20,34 @@ export function decimalToBinary (num: number): string {
   return res
 }
 
+/**
+ * decimal to binary
+ * 
+ * @group decimal-conversion
+ *
+ * @param num - Enter a value of number type
+ * @returns Return the corresponding binary
+ * 
+ * @example
+ * ```ts
+ * tenToTwo(10) // '1010'
+ * ```
+ */
 export const tenToTwo = decimalToBinary
 
+/**
+ * binary to decimal
+ * 
+ * @group decimal-conversion
+ * 
+ * @param str - Enter a value of string type
+ * @returns Return the corresponding number
+ * 
+ * @example
+ * ```ts
+ * binaryToDecimal('1010') // 10
+ * ```
+ */
 export function binaryToDecimal (str: string): number {
   let res = 0
   let digit = 0
@@ -19,4 +58,17 @@ export function binaryToDecimal (str: string): number {
   return res
 }
 
+/**
+ * binary to decimal
+ * 
+ * @group decimal-conversion
+ * 
+ * @param str - Enter a value of string type
+ * @returns Return the corresponding number
+ * 
+ * @example
+ * ```ts
+ * twoToTen('1010') // 10
+ * ```
+ */
 export const twoToTen = binaryToDecimal