Options
All
  • Public
  • Public/Protected
  • All
Menu

logo

NPM Version Build Status Coverage Status Size Gzip Size License

dayjs 基础上封装的常用日期操作类库。

https://fjc0k.github.io/vtils/date

安装

# yarn
yarn add @vtils/date

# or, npm
npm i @vtils/date --save

你也可通过 CDN 安装,然后使用全局变量 vd 访问相关工具:

<script src="https://cdn.jsdelivr.net/npm/@vtils/date@2.59.0/lib/index.umd.min.js" crossorigin="anonymous"></script>

Index

Functions

formatDate

  • formatDate(date: ConfigType, template: string): string
  • 格式化日期。

    example
    formatDate('2019-9-1', 'YYYY年M月D日') // => 2019年9月1日

    Parameters

    Returns string

    返回格式化后的日期字符串

numeralDayToChineseDay

  • numeralDayToChineseDay(day: number): string
  • 数字星期转中文星期。07 都视为星期日。

    example
    numeralDayToChineseDay(0) // => 日
    numeralDayToChineseDay(1) // => 一
    numeralDayToChineseDay(5) // => 五
    numeralDayToChineseDay(7) // => 日

    Parameters

    • day: number

      数字的星期几

    Returns string

    返回中文的星期几

toDayjs

  • toDayjs(date: ConfigType): Dayjs
  • 转换输入的日期为 Dayjs 实例。

    example
    // 字符串
    toDayjs('2019-9-1')
    // Date 实例
    toDayjs(new Date(2019, 8, 1))
    // unix 时间戳
    toDayjs(1569643555)
    // Dayjs 实例
    toDayjs(dayjs())

    Parameters

    • date: ConfigType

      输入的日期

    Returns Dayjs

    返回 Dayjs 实例

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc