Merge pull request #28 from mbti-nf-team/feat/issue-27

.changeset/grumpy-singers-taste.md

@@ -0,0 +1,7 @@
+---
+"@nft-team/eslint-config": patch
+"@nft-team/react": patch
+"@nft-team/core": patch
+---
+
+docs: typedoc 세팅, ts docs 작성 및 문서 업데이트

README.md

@@ -5,7 +5,7 @@
 </a>
 
 <a href="https://github.com/mbti-nf-team/frontend-libraries/blob/main/LICENSE">
-  <img src="https://img.shields.io/github/license/mbti-nf-team/frontend-libraries?style=flat-square">
+  <img src="https://img.shields.io/github/license/mbti-nf-team/frontend-libraries?style=flat-square" />
 </a>
 
 ## 📚 Libraries

apps/docs/babel.config.js

@@ -1,3 +1,6 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  presets: [
+    require.resolve('@docusaurus/core/lib/babel/preset'),
+    ['@babel/preset-react', { runtime: 'automatic' }],
+  ],
 };

apps/docs/docs/api/_category_.yml

@@ -0,0 +1 @@
+label: "API"

apps/docs/docs/api/index.md

@@ -0,0 +1,31 @@
+---
+id: "index"
+title: "Documentation"
+sidebar_label: "Readme"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+# 🚧 WIP 🚧 @nft-team frontend-libraries
+
+<a href="https://github.com/mbti-nf-team/frontend-libraries/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">
+  <img src="https://img.shields.io/github/issues/mbti-nf-team/frontend-libraries?style=flat-square" />
+</a>
+
+<a href="https://github.com/mbti-nf-team/frontend-libraries/blob/main/LICENSE">
+  <img src="https://img.shields.io/github/license/mbti-nf-team/frontend-libraries?style=flat-square" />
+</a>
+
+## 📚 Libraries
+- [@nft-team/react](https://github.com/mbti-nf-team/frontend-libraries/tree/main/packages/react)
+  - [npm](https://www.npmjs.com/package/@nft-team/react)
+- [@nft-team/core](https://github.com/mbti-nf-team/frontend-libraries/tree/main/packages/core)
+  - [npm](https://www.npmjs.com/package/@nft-team/core)
+- [@nft-team/eslint-config](https://github.com/mbti-nf-team/frontend-libraries/tree/main/packages/eslint)
+  - [npm](https://www.npmjs.com/package/@nft-team/eslint-config)
+
+## 🐛 Bug reporting
+[Issues](https://github.com/mbti-nf-team/frontend-libraries/issues)
+
+## 🔒 LICENSE
+This Project is [MIT licensed](https://github.com/mbti-nf-team/frontend-libraries/blob/main/LICENSE).

apps/docs/docs/api/modules.md

@@ -0,0 +1,9 @@
+---
+id: "modules"
+title: "Documentation"
+sidebar_label: "Table of Contents"
+sidebar_position: 0.5
+hide_table_of_contents: true
+custom_edit_url: null
+---
+

apps/docs/docs/api/modules/_category_.yml

@@ -0,0 +1,2 @@
+label: "Modules"
+position: 1

apps/docs/docs/api/modules/nft_team_core.md

@@ -0,0 +1,176 @@
+---
+id: "nft_team_core"
+title: "Module: @nft-team/core"
+sidebar_label: "@nft-team/core"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Functions
+
+### checkEmpty
+
+▸ **checkEmpty**<`T`\>(`value?`): `T`[]
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value?` | `T`[] |
+
+#### Returns
+
+`T`[]
+
+#### Defined in
+
+[utils.ts:44](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L44)
+
+___
+
+### checkNumber
+
+▸ **checkNumber**(`value?`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value?` | ``null`` \| `number` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[utils.ts:26](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L26)
+
+___
+
+### emptyAThenB
+
+▸ **emptyAThenB**(`b`, `a?`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `b` | `string` |
+| `a?` | ``null`` \| `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils.ts:34](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L34)
+
+___
+
+### generateArrayOfNumber
+
+▸ **generateArrayOfNumber**(`length`): `number`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `length` | `number` |
+
+#### Returns
+
+`number`[]
+
+#### Defined in
+
+[utils.ts:64](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L64)
+
+___
+
+### isEmpty
+
+▸ **isEmpty**<`T`\>(`value?`): `boolean`
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value?` | `T`[] |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[utils.ts:52](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L52)
+
+___
+
+### removeNullable
+
+▸ **removeNullable**(`value?`, `replacementValue?`): `string`
+
+**`Description`**
+
+`null`이나 `undefined`값이 존재하는 경우 빈문자열로 대체하거나 새로운 문자열로 대체합니다. (오로지 `string` 타입으로 반환)
+
+```ts
+const value = undefined;
+const result = removeNullable(value, 'newValue');
+```
+
+**`Example`**
+
+```ts
+console.log(result); // 'newValue';
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value?` | ``null`` \| `string` | 첫 번째 인자 `string` \| `null` \| `undefined` |
+| `replacementValue?` | `string` | 두 번째 인자에 값이 존재하는 경우 첫 번째 인자가 `null` 또는 `undefined`인 경우 두번째 인자로 문자열 대체 |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils.ts:14](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L14)
+
+___
+
+### trueOrFalse
+
+▸ **trueOrFalse**(`value?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value?` | ``null`` \| `string` \| `number` \| `boolean` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[utils.ts:36](https://github.com/mbti-nf-team/frontend-libraries/blob/91b0747/packages/core/src/utils.ts#L36)