uyu423/resume-nextjs

View on GitHub
component/experience/IExperience.ts

Summary

Maintainability
A
0 mins
Test Coverage
import { ICommon } from '../common/ICommon';

export declare namespace IExperience {
  /**
   * ### Sample Rendering
   *
   * ![image](https://user-images.githubusercontent.com/8033320/78032558-27540200-73a0-11ea-83cd-3fd1cea68402.png)
   *
   * @example https://github.com/uyu423/resume-nextjs/blob/master/payload/experience.ts
   */
  export interface Payload extends ICommon.Payload {
    /** ### Experience 데이터 목록 */
    list: Item[];
    /** ### 총 경력 기간 표시 유/무 */
    disableTotalPeriod?: boolean;
  }

  export interface Item {
    /** ### (직장)경험 명 */
    title: string;

    /** ### (직장)역할 명 (or Subtitle) */
    position: string;

    /**
     * ### (직장)경험 시작 일
     *
     * @format YYYY-MM
     * @example "2018-02"
     */

    startedAt: string;
    /**
     * ### (직장)경험 종료 일
     *
     * @format YYYY-MM
     * @example "2021-02"
     * @description 해당 값이 undefined 일 경우 **"재직 중"** 뱃지가 추가로 나타난다.
     */

    endedAt?: string;
    /**
     * ### (직장)경험 설명
     *
     * @description 하나의 `string` 요소가 `<ul>` 태그 안의 `<li>` 가 된다.
     * @todo `IRow.Description[]` 으로 변경
     */

    descriptions: string[];
    /**
     * ### (직장)경험의 키워드
     *
     * @description undefined 가 아닐 경우 해당 경험 하단에 **Skill Keywords** 목록이 추가된다.
     */

    skillKeywords?: string[];
  }
}