@jk-core/utils/README.md

utils for jk

# @jk-core/utils

jk-core 프로젝트를 위한 React 커스텀 유틸 모음입니다.

<br/>

## 설치
```bash
npm install @jk-core/utils // npm 사용시
yarn add @jk-core/utils // yarn 사용시
pnpm add @jk-core/utils // pnpm 사용시
```

<br/>

## 사용 가능한 기능

### cn

css module을 사용할 때, `cn({[classname]: boolean})` 과 같이 조건부에 따라 className을 부여할 수 있는 기능입니다.

#### 사용법
```typescript
import { cn } from '@jk-core/utils';

const MyComponent = ({ className, ...props }) => (
  <div className={cn({
    [className]: true,
    'some-class': true,
  })}>
    {/* ... */}
  </div>
);
```
<br/>
<br/>

### roundNum

숫자를 지정된 소수점 자리까지 반올림하는 함수입니다. null 값이 들어오면 0을 반환합니다.

#### Props

| Prop name | Description | Default value | Example values |
|-----------|-------------|---------------|----------------|
| num       | 반올림할 숫자입니다. | -             | `1234.5678`, `null` |
| scale     | 반올림할 소수점 자리수입니다. | `2`           | `0`, `3`            |

#### 사용법
```typescript
const rounded = roundNum(1234.5678, 2); // 1234.57
const rounded2 = roundNum(null, 2); // 0
```
<br/>
<br/>

### displayRoundNum

숫자를 지정된 소수점 자리까지 반올림하는 함수입니다. null 값이나 undefined가 들어오면 "-"을 반환합니다.

#### Props

| Prop name | Description | Default value | Example values |
|-----------|-------------|---------------|----------------|
| num       | 반올림할 숫자입니다. | -             | `1234.5678`, `null`, `undefined` |
| scale     | 반올림할 소수점 자리수입니다. | `2`           | `0`, `3`            |

#### 사용법
```typescript
const rounded = displayRoundNum(1234.5678, 2); // 1234.57
const rounded2 = displayRoundNum(null, 2); // "-"
const rounded3 = displayRoundNum(undefined, 2); // "-"
```
<br/>
<br/>

### checkIsMobile

사용자의 기기가 모바일인지 확인하는 함수입니다.

#### 사용법
```typescript
const isMobile = checkIsMobile(); // true 또는 false 반환
```
<br/>
<br/>

### isDefined

값이 null 또는 undefined인지 확인하는 함수입니다.

#### 사용법
```typescript
const isDefined = isDefined(value); // true 또는 false 반환
```