Outqource-Node

기능 작성 진행중

Prisma

ControllerAPI (Type)

• tags : 대분류
• path : Endpoint
• method : REST API Method
• param
• query
• header
• body
• auth : 인증 방식 "jwt" | "cookie" | "session"
• summary : 요약
• description : 설명
• formData
• response : Response 예시

예시

export const createReviewAPI: ControllerAPI = {
  tags: ['Review'],
  summary: '리뷰 생성하기',
  path: '/reviews',
  method: 'POST',
  auth: 'jwt',
  middlewares: [authorization.USER],
  body: [
    { key: 'content', type: 'string' },
    { key: 'score', type: 'number' },
    { key: 'doctorId', type: 'string', nullable: true },
    { key: 'pharmacistId', type: 'string', nullable: true },
  ],
  responses: [responseWithId(201)],
};

createPrismaController<T> : CRUD API 작성 , T : Prisma Option

• params
  • database : PrismaClient
  • controllerAPI : ControllerAPI
  • options : PrismaOption (T)

export const getReviews = createPrismaController<PrismaClient.ReviewFindManyArgs>(Prisma, getReviewsAPI, {
  table: 'Review',
  actions: ['findMany', 'count'],
  options: {
    where: {
      deletedAt: null,
    },
    orderBy: {
      createdAt: 'desc',
    },
  },
});

Express

ExpressController (Type) : req, res, next => void

createResponse : response generator

• skip
• take
• count
• data

InitApp : Express Application

const initApp = new InitApp({
  controllers,
  openAPI: {
    path: path.join(__dirname, config.SWAGGER_PATH),
    options: openAPIOptions,
    endPoint: '/api-docs',
  },
});
await initApp.init();

initApp.app.use(express.json({ limit: '50mb' }));
initApp.app.use(express.urlencoded({ limit: '50mb' }));
initApp.app.use(bodyParser.json({ limit: '50mb' }));
initApp.app.use(bodyParser.urlencoded({ limit: '50mb', extended: true }));

initApp.middlewares([], { jwtUserCallback });

initApp.app.get('/', (req, res) => {
  res.redirect('/api-docs');
});

initApp.routers({
  globalOptions: {
    html: '<h1></h1>',
    status: 200,
  },
});

initApp.app.listen(config.PORT, () => {
  console.log(`🚀 Sever Listening on ${config.PORT}...`);
});

Common

알리고

알리고 문자 메시지 전송 Class

• sendMessage
• sendMessages

const aligo = new Aligo(userId, key, sender);

aligo.sendMessage({ phoneNumber, message });
aligo.sendMessages([
  { phoneNumber, message },
  { phoneNumber, message },
]);

Axios

• onRequest

--

Encrypt (암호화)

암호화 Class

• async hash
• signAES
• verifyAES

const encrypt = new Encrypt({aes? , saltRound});

encrypt.hash(value, saltRound?);
encrypt.signAES(value);
encrypt.verifyAES(value);

Firebase

파이어 베이스 PushNotification Class

const firebaseMessage = new FirebaseMessaging(serviceAccount)
//serviceAccount : firebase config json 파일

firebaseMessage.sendMessage({token , notification : Notification})
firebaseMessage.sendMessages(messages : SendMessageProps)

단일 메시지 전송

sendMessage({token , notificaion : Notification} : SendMessageProps)

• SendMessageProps

• token :string

  대상 토큰

• notifiction : Notification

  • title? : string

    메시지 제목

  • body? : string

    메시지 내용

  • imageUrl? : string

    첨부 이미지

다수 메시지 전송

sendMessages(messages : SendMessageProps)

• SendMessagesProps

• SendMessage[]

Hangul

데이터 초성 검색 가능 Class

const hangul = new Hangul();

const data = hangul.getChosungSearchedData<T>('name', rowData, 'ㅂㄱㅇ');

getChosungSearchedData< T extends Record<string,any> >(target : keyof T , data :T[], keyword : string) : T[]

• target : keyof T

  검색 대상의 key값

• data : T[]

  검색 대상

• keyword : string

  검색 키워드

Iamport

아임포트 결제/인증 관련 Class

const iamport = new Iamport({ imp_key, imp_secret, merchat_id, pg });

await iamport.getToken({ imp_key, imp_secret });
await iamport.getPaymentData({ access_token, imp_uid });
await iamport.getPaymentDataWithAccessToken({ imp_key, imp_secret, imp_uid });
await iamport.completePayment({ imp_key, imp_secret, imp_uid, productAmount });
await iamport.cancelPayment({ imp_key, imp_secret, imp_uid, reason, productAmount });
await iamport.getCertificationData({ access_token, imp_uid });
await iamport.getCeritificationDataWithAccessToken({ imp_key, imp_secret, imp_uid });

엑세스 토큰 추출 Method

getToken({imp_key , imp_secret} : IamportTypes.getToken) : Promise<string | null>

• imp_key?: string

  아임포트로부터 발급받은 key

• imp_secret?: string

  아임포트로부터 발급받은 secret_key

• merchant_id?: string

  ex) imp00000000

• pg?: string

  ex) tosstest

결제 정보 불러오기

getPaymentData({access_token ,imp_uid} : IamportTypes.getPaymentData) : Promise<any | null>

• access_token: string

  getToken을 통해 발급받은 accessToken

• imp_uid: string

  아임포트로부터 발급받은 imp_uid

액세스 토큰 발금 + 결제 정보 불러오기

getPaymentDataWithAccessToken({imp_key , imp_secret, imp_uid} : IamportTypes.getPaymentDataWithAccessToken) : Promise<any | string>

• imp_key?: string

  아임포트로부터 발급받은 key

• imp_secret?: string

  아임포트로부터 발급받은 secret_key

• imp_uid: string

  아임포트로부터 발급받은 imp_uid

액세스 토큰 발금 + 결제 정보 불러오기

completePayment({imp_key , imp_secret, imp_uid, productAmount } : IamportTypes.getTcompletePaymentoken) : Promise<IamportTypes.TcompletePayment>

• imp_key?: string

  아임포트로부터 발급받은 key

• imp_secret?: string

  아임포트로부터 발급받은 secret_key

• imp_uid: string

  아임포트로부터 발급받은 imp_uid

• productAmount: string | number

  결제 가격

IamportTypes.TcompletePayment

• status: number

• message: string

• completeStatus?: string

• data?: any

카드 환불

cancelPayment({imp_key , imp_secret, imp_uid, reason ,cancelAmount } : IamportTypes.cancelPayment) : Promise<any | null>

• imp_key?: string

  아임포트로부터 발급받은 key

• imp_secret?: string

  아임포트로부터 발급받은 secret_key

• imp_uid: string

  아임포트로부터 발급받은 imp_uid

• reason?: string

  취소 사유

• cancelAmount: string | number

  취소 가격

휴대폰 본인인증 정보 얻기

getCertificationData({access_token ,imp_uid} : IamportTypes.getCertificationData) : Promise<any | null>

• access_token: string

  getToken을 통해 발급받은 accessToken

• imp_uid: string

  아임포트로부터 발급받은 imp_uid

휴대폰 본인인증 토큰 발급과 함께 얻기

getCeritificationDataWithAccessToken({imp_key , imp_secret, imp_uid, productAmount } : IamportTypes.getCeritificationDataWithAccessToken) : Promise<any | null>

• imp_key?: string

  아임포트로부터 발급받은 key

• imp_secret?: string

  아임포트로부터 발급받은 secret_key

• imp_uid: string

  아임포트로부터 발급받은 imp_uid

JsonwebToken

jwt 생성 및 검증 Class

const jwt = new JsonwebToken(jwt_key, { signOptions, verifyOptions });

const signedPayload = jwt.signJwt<{ id: string }>(value, signOptoins);
const verifiedPayload = jwt.verifyJwt<{ id: string }>(value, verigyOptions);

jwtKey : string

jwt 생성에 사용할 key 값`

signOptions? : SignOptions

• algorithm (default: HS256)
• expiresIn: expressed in seconds or a string describing a time span vercel/ms.

  Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

• notBefore: expressed in seconds or a string describing a time span vercel/ms.

  Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

• audience
• issuer
• jwtid
• subject
• noTimestamp
• header
• keyid
• mutatePayload: if true, the sign function will modify the payload object directly. This is useful if you need a raw reference to the payload after claims have been applied to it but before it has been encoded into a token.

verifyOptions? : VerifyOptions

• algorithms: List of strings with the names of the allowed algorithms. For instance, ["HS256", "HS384"].
• audience: if you want to check audience (aud), provide a value here. The audience can be checked against a string, a regular expression or a list of strings and/or regular expressions.

  Eg: "urn:foo", /urn:f[o]{2}/, [/urn:f[o]{2}/, "urn:bar"]

• complete: return an object with the decoded { payload, header, signature } instead of only the usual content of the payload.
• issuer (optional): string or array of strings of valid values for the iss field.
• jwtid (optional): if you want to check JWT ID (jti), provide a string value here.
• ignoreExpiration: if true do not validate the expiration of the token.
• ignoreNotBefore...
• subject: if you want to check subject (sub), provide a value here
• clockTolerance: number of seconds to tolerate when checking the nbf and exp claims, to deal with small clock differences among different servers
• maxAge: the maximum allowed age for tokens to still be valid. It is expressed in seconds or a string describing a time span vercel/ms.

  Eg: 1000, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

• clockTimestamp: the time in seconds that should be used as the current time for all necessary comparisons.
• nonce: if you want to check nonce claim, provide a string value here. It is used on Open ID for the ID Tokens.

Location

카카오, 구글 기반 위치 정보 및 거리 계산

const location = new Location({ kakaoRestKey, googleRestkey });

const kakaoLocationByAddress = await location.getKakaoLocationByAddress({
  address,
  analyze_type,
  page,
  limit,
  kakaoRestKey,
});

const kakaoLocationByKeyword = await location.getKakaoLocationByKeyword({
  keyword,
  latitude,
  longitude,
  radius,
  page,
  limiy,
  kakaoRestKey,
});

const kakaoLocationByGeocode = await location.getKakakoLocationByGeocode({
  latitude,
  longitude,
  page,
  limit,
  kakaoRestkey,
});

const googleLocationByGeocode = await location.getGoogleLocationByGeocode({
  latitude,
  longitude,
  googleRestKey,
});

const distance = location.getDistance({
  target: {
    latitude,
    longitude,
  },
});

getKakoLocationByAddres({address, analyze_type, page, limit, kakaoRestKey} : IKakaoAddress) : Promise<{data : KakaoAddressResponse[]; count : number} | null>

• IKakaoAddress

• address : string

  검색 대상의 주소

• analyze_type? : "similar" | "exact"

  검색 type - similar : 유사 주소, exact : 정확한 주소

• page? : number

• limit? : number

• kakaoRestKey? :string

getKakaoLocationByKeyword({ keyword ,latitude ,longitude , radius , page ,limit ,kakaoRestKey,}: IKakaoKeyword) : Promise<{ data: Array<KakaoKeywordResponse>; count: number } | null>

• IKakaoKeyword

• keyword :string

  검색을 원하는 질의어

• radius? : number

  중심 좌표로부터의 반경거리 (단위 : 미터)

• latitude? : string

  중심 좌표의 Y 혹은 위도

• longitude? : string

  중심 좌표의 X 혹은 위도

• page? : number

• limit? : number

• kakaoRestKey? : string

getKakaoLocationByGeocode({latitude ,longitude , page ,limit ,kakaoRestKey,}: IKakaoGeocode) : Promise<{ data: Array<KakaoKeywordResponse>; count: number } | null>

• IKakaoGeocode

• latitude? : string

  중심 좌표의 Y 혹은 위도

• longitude? : string

  중심 좌표의 X 혹은 위도

• page? : number

• limit? : number

• kakaoRestKey? : string

• KakaoAddressResponse

• address_name : string

  전체 지번 주소

• address_type : KakakoAddressType

  • KakaoAddressType : "REGION" | "ROAD" | "REGION_ADDR" | "ROAD_ADDR"

    REGION(지명)

    ROAD(도로명)

    REGION_ADDR(지번 주소)

    ROAD_ADDR(도로명 주소)

• address : KakaoAddress

  • KakaoAddress

    • address_name: string

      전체 지번 주소

    • region_1depth_name: string

      지역 1 Depth, 시도 단위

    • region_2depth_name: string

      지역 2 Depth, 구 단위

    • region_3depth_name: string

      지역 3 Depth, 동 단위

    • region_3depth_h_name: string

      지역 3 Depth, 행정동 명칭

    • h_code: string

      행정 코드

    • b_code: string

      법정 코드

    • moutain_yn: 'Y' | 'N'

      산 여부 , Y 또는 N

    • main_address_no: string

      지번 주번지

    • sub_address_no: string

      지번 부번지, 없을 경우 빈 문자열

    • x: string

      X 좌표값, 경위도인 경우 경도(longitude)

    • y: string

      Y 좌표값, 경위도인 경우 위도(latitude)

getGoogleLocationByGeocode({googleRestKey, latitude, longitude,}: IGoogleGeocode) : Promise<{ data: Array<GoogleGeocodeResponse>; count: number } | null>

• IKakaoGeocode

• latitude? : string

  중심 좌표의 Y 혹은 위도

• longitude? : string

  중심 좌표의 X 혹은 위도

• googleRestKey? : string

• GoogleGeocodeResponse

  • id : string

    해당 좌표의 id 값

  • address_name: string

    전체 지번 주소

  • region_1depth_name: string

    지역 1 Depth, 시도 단위

  • region_2depth_name: string

    지역 2 Depth, 구 단위

  • region_3depth_name: string

    지역 3 Depth, 동 단위

  • region_3depth_h_name: string

    지역 3 Depth, 행정동 명칭

getDistance({target , current} : DistanceProps) : number

• DistanceProps

• target : Geocode

• current : Geocode

  • Geocode

    • latitude? : string

      중심 좌표의 Y 혹은 위도

    • longitude? : string

      중심 좌표의 X 혹은 위도

QrCode

QrCode를 생성하는 Class

const qrCode = new QrCode();

const { qrFromData, base64 } = await qrCode.createQRCodeData({ target, fileName });

const { success, failure } = await qrCdoe.createQRCodesData([{ target, fileName }]);

createQRCodeData({target, fileName} : IQrCode) : Promise<QRCodeData | undefined>

• IQrCode

• target : string

  qr코드로 생성할 데이터 (Object -> JSON.stringify)

• fileName? : string

  파일 이름

• QRCodeData

• qrFormData: FormData

  qr코드 formData (key : file)

• base64: Buffer

  qr코드 Buffer

createQRCodesData([{target , fileName}] : Array<IQrCode>) : Promise<QrCodesResponse>

• QrCodesResponse

• success : Array<QRCodeData>

  qr코드 생성에 성공한 배열

• failure : Array<IQrCode>

  qr코드 생성에 실패한 배열

Sharp

이미지 리사이징 Class

const sharp = new Sharp({ maxWidth, maxHeight });

const newBuffer = await sharp.resizeImage(buffer);

• maxWidth? : number

• maxHeight? : number

• resizeImage(buffer : Buffer) : Promise<Buffer>

Social

소셜 로그인 관련

Apple

애플 소셜 로그인 Class

const appleSocial = new Apple({ appleConfig, path });

app.get('/auth/apple', (req, res, next) => {
  appleSocial.getRest(res);
});

app.post('/auth/apple/callback', async (req, res, next) => {
  const { id_token } = req.body;
  const appleUser = await appleSocial.getRestCallback(id_token);
});

const appleUser = await appleSocial.getUser(id_token);

• appleConfig : AppleAuthConfig

  애플 config 관련 파일 (json)

• path : string

  애플 private key 파일 경로

getRestCallback(code : string) :Promise<AppleTypes.User | undefined>

getUser(id_token : string) : Promise<AppleTypes.User | undefined>

• AppleTypes.User

  • id : string

  • email?: string

    이메일의 경우 유저가 동의해야 사용 가능.

Google

구글 소셜 로그인 Class

const googleSocial = new Google({ clientId, clientSecret, redirectUrl });

app.get('/auth/google', (req, res, next) => {
  googleSocial.getRest(res);
});

app.get('/auth/google/callback', (req, res, next) => {
  const { code } = req.query;
  const { token, user } = await googleSocial.getRestCallback(code);
});

const googleAccessToken = googleSocial.getToken(code);
const googleAppUser = googleSocial.getAppUser(token); //id_token
const googleWebUser = googleSocial.getWebUser(token); //accessToken

• clientId : string

  구글 OAuth 2.0 등록 시 발급받은 clientId

• clientSecret? : string

  구글 OAuth 2.0 등록 시 발급받은 clientSecret

• redirectUrl? : string

  구글 로그인 Callback Url

getRest(res : Response, redirectUrl : string)

구글 로그인 리다이렉팅

getToken(code : string) : Promise<string | undefined>

• code : string

  로그인 성공 후 리다이렉팅을 통해 전달 받은 code

getAppUser(token :string) : Promise<GoogleSocial.User | undefined>

• token : string

  id_token 값

• GoogleSocial.User

  • id: string

  • email?: string

  • nickname?: string

  • profileImage?: string

getWebUser(token :string) : Promise<GoogleSocial.User | undefined>

• token : string

  access_token 값

getRestCallback(code :string) : Promise<GoogleSocial.TgetRestCallback | undefined>

• code: : string

  로그인 성공 후 리다이렉티을 통해 전달 받은 code

• GoogleSocial.TgetRestCallback

  • token: string

  • user: GoogleSocial.User

Kakao

카카오 소셜 로그인 Class

const kakaoSocial = new Kakao({ kakaoRestKey, kakaoSecreteKey, kakaoAdminKey, kakaoRedirectUrl });

app.get('/auth/kakao', (req, res, next) => {
  kakaoSocial.getRest(res);
});

app.get('/auth/kakao/callback', (req, res, next) => {
  const { code } = req.query;
  const { token, user } = await kakaoSocial.getRestCallback(code);
});

const kakaoUser = await kakaoSocial.getUser(token);
const kakaoAceessToken = await kakaoSocial.getToken(code, redirectUrl);

• kakaoRestKey : string

  카카오 어플리케이션 등록시 발급받은 REAT_API_KEY

• kakaoSecretKey? : string

  카카오 어플리케이션 등록시 발급받은 SECRET_KEY (추가 설정 요소)

• kakaoAdminKey? :string

  카카오 어플리케이션 등로깃 발급받은 ADMIN_KEY

• kakaoRedirectUrl? : string

  카카오 로그인 리다이렉트 url

getRest(res : Response , redirectUrl? : string)

getToken(code : string, redirectUrl? :string) : Promise<string | undefined>

• code : string

  카카오 로그인을 통해 발급 받은 code

• redirectUrl? : string

  Class 생성자를 통해 등록하지 않았을 경우 필수

getRestCallback(code :string) : Promise<KakaoSocial.TgetRestCallback | undefined>

• code : string

  카카오 로그인 을 통해 발급 받은 code

• KakaoSocail.TgetRestCallback

  • token : string

    카카오 Access Token

  • user : TgetUser

  • TgetUser

    • id : string

    • properties

      • nickname? : string

      • profile_image : string

      • thumbnail_image : string

    • kakaoAcount : account

      • profile? : Profile

        • nickname? : string

        • thumbnail_image_url? : string

        • profile_image_url? : string

        • is_default_image? : boolean

      • name? : string

      • email? : string

      • birthYear? : string

      • birthday? : string

      • gender? : "femail" | "mail"

      • phone_number? : string

카카오 유저 정보의 경우 카카오 어플리케이션에서 등록 필수

getUser(token : string) : Promise<KakaoSocial.TgetUser | undefined>

Naver

네이머 소셜 로그인 Class

const naverSocial = new Naver({ clienId, clientSecret, redirectUrl });
const code = 'naver_code'; // 임의의 값 사용
app.get('/auth/naver', (req, res, next) => {
  naverSocial.getRest(res, code);
});

app.get('/auth/naver/callback', (req, res, next) => {
  const { code } = req.query;
  const { token, user } = await naverSocial.getRestCallback(code);
});

const naverUser = await naverSocial.getUser(token);
const naverAceessToken = await naverSocial.getToken(code, redirectUrl);

• clientId : string

  네이버 디벨로퍼스 등록시 발급받은 clientId

• clientSecret? : string

  네이버 디벨로퍼스 등록시 발급받은 clientSecret

• redirectUrl? : string

  네이버 로그인 Callback Url

getRest(res: Response , code :string, redirectUrl? : string )

• code : string

  로그인 검증을 위해 사용되는 임의의 코드

getUser(token :string) :Promise<NaverSOcial.User | undefined>

• token : string

  네이버 Access Token

• NaverSocial.User

  • id :string

  • email? : string

  • gender? : string

  • age? : string

  • phoneNumber? : string

getToken(code : string) : Promise<NaverSocial.Token | undefined>

• code : string

  네이버 로그인을 통해 발급받은 code

• NaverSocial.Token

  • token : string

  • tokenType : string

    Bearer와 MAC

getRestCallback(code : string) : Promise<NaverSocial.TgetRestCallback>

• NaverSocial.TgetRestCallback

• token : string

• tokenType : string

• user : NaverSocial.User

Date

날짜와 관련된 Functions

getWeekNumberByMonth (date :string) : WeekNumberByMonth

해당 날짜의 연도, 월, n번째 주 값을 구하는 함수

• date : string

  구하고자하는 날짜

• WeekNumberByMonth

  • year : number

  • month : number

  • weekNo : number | string

getTodayStartEnd () : TodayStartEnd

오늘의 시작과 끝 시간 구하는 함수

• TodayStartEnd

  • todayStart : Date

  • todayEnd : Date

getDateStartToLast (startDate : string , lastDate : string) : string[] | null

시작과 끝 사이 날짜 (연월일) 배열 구하는 함수

DTO

DTO 관련 제너레이터

getPagination(take :number, skip :number, count : number) : TPagination

TPagination

• page: number

• limit : number

• offset : number

• count : number

• isNext : boolean

• isPrev : boolean

paginationRequestDTO():ValidatorItem[]

페이지네이션 관련 request 형식

const paginationRequestDTO = (): ValidatorItem[] => {
  return [
    { key: 'page', type: 'number', default: 1, nullable: true },
    { key: 'limit', type: 'number', default: 20, nullable: true },
  ];
};

createListResponse<T>(row : T ,status : ControllerAPIResponseStatusCode) : {status , exmaple}

리스트 형식 데이터 example DTO 생성 함수

export const createListResponse = <T>(rows: T, status?: ControllerAPIResponsStatusCode) => ({
  status: status || 200,
  example: { pagination: paginationDTO, rows: range(0, 3).map(() => rows) },
});

tokenDTO (status : ControllerAPIResponsStatusCode) : {status , eample}

auth(login, register)관련 api response example에 사용

export const tokenDTO = (status: ControllerAPIResponsStatusCode) => {
  return {
    status,
    example: {
      accessToken: 'string',
      refreshToken: 'string',
    },
  };
};

emptyResponse (status : ControllerAPIResponsStatusCode) : {status , eample}

Response Status 204 api response example에 사용

export const emptyResponse = (status: ControllerAPIResponsStatusCode) => {
  return {
    status,
    example: {},
  };
};

responseWithId (status : ControllerAPIResponsStatusCode) : {status , eample}

Response Status 201 api response example에 사용

export const responseWithId = (status: ControllerAPIResponsStatusCode) => {
  return {
    status,
    example: { id: 'string' },
  };
};

Enum

getEnumValues(target) : string[]

enum 관련 example 작성 시 사용

export const getEnumValues = <T extends object>(target: T) => {
  const value = Object.values(target).reduce(
    (prev, curr) => {
      prev[0] += curr + ',';
      return prev;
    },
    [''],
  );
  return [value[0].slice(0, value[0].length - 1)];
};

//usage
response: [{ key: 'enum_example', type: 'enum', example: getEnumValues(ENUM) }];

Excel

액셀 차트 생성 시 사용 (보완 필요)

getDefaultExcelSheet(data : Record<string,any>, convertHeader:(header)=>string) : Array<TStatisticsExcel>

convertExcelFile(rows: TStatisticExcel[]) : Promise<ExcelJS.Buffer>

const convertHeader = (header: string): string => {
  const places = Object.keys(Place);

  if (places.includes(header)) return convertPlaceEnum(header);
  else if (header === 'total') return '전체';
  else return header;
};

const result = await this.statisticsService.getFavoriteCountByChargeStation();

const file = await convertExcelFile(getDefaultExcelSheet(result, convertHeader));
//or
const file = await getExcelfile(result, convertHeader);

• TStatisticExcel

• header : string

• data : Array<string>

• extra ? : {}

  • title : string

  • headers : Array<string>

  • extraData : Array<string>

ParseValue

value 파싱 관련

checkJsonString(value) : boolean

const checkJsonString = (value: string): boolean => {
  try {
    const result = JSON.parse(value);
    if (result && typeof result === 'object') {
      return true;
    }
    throw new Error('not json');
  } catch (error) {
    return false;
  }
};

parseAutoValue(value) : boolean

export const parseAutoValue = (value: string) => {
  const isNumberValue = Number(value);
  const isBooleanValue = value === 'TRUE' || value === 'FALSE' || value === 'true' || value === 'false';
  const isJsonValue = checkJsonString(value);

  if (isNumberValue) {
    return isNumberValue;
  } else if (isBooleanValue) {
    return value === 'TRUE' || value === 'true';
  } else if (isJsonValue) {
    return JSON.parse(value);
  } else {
    return value;
  }
};

parseValue(value) : boolean

export const parseValue = (value: string, type: ParseDataType | string | 'auto' = 'auto') => {
  switch (type) {
    case 'string':
      return value;
    case 'boolean':
      return value === 'TRUE' || value === 'true';
    case 'number':
      return Number(value);
    case 'json':
      return JSON.parse(value);
    case 'auto':
      return parseAutoValue(value);
    default:
      return parseAutoValue(value);
  }
};

Random

랜덤값 관련

randomNumber(min: number, max : number): number

export const randomNumber = (min: number, max: number) => {
  return Math.floor(Math.random() * (max - min)) + min;
};

ß