docs: update docs customParseFormat

iamkun · Feb 23, 2019 · 6b555bf · 6b555bf
1 parent a0a97ff
commit 6b555bf
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 7 deletions.
diff --git a/docs/en/Plugin.md b/docs/en/Plugin.md
@@ -261,7 +261,7 @@ dayjs.extend(customParseFormat)
 dayjs('05/02/69 1:02:03 PM -05:00', 'MM/DD/YY H:mm:ss A Z')
 // Returns an instance containing '1969-05-02T18:02:03.000Z'
 
-dayjs('2018 Enero 15', { format: 'YYYY MMMM DD', locale: 'es' })
+dayjs('2018 Enero 15', 'YYYY MMMM DD', 'es')
 // Returns an instance containing '2018-01-15T00:00:00.000Z'
 ```
 

diff --git a/docs/es-es/Plugin.md b/docs/es-es/Plugin.md
@@ -261,7 +261,7 @@ dayjs.extend(customParseFormat)
 dayjs('05/02/69 1:02:03 PM -05:00', 'MM/DD/YY H:mm:ss A Z')
 // Returns an instance containing '1969-05-02T18:02:03.000Z'
 
-dayjs('2018 Enero 15', { format: 'YYYY MMMM DD', locale: 'es' })
+dayjs('2018 Enero 15', 'YYYY MMMM DD', 'es')
 // Returns an instance containing '2018-01-15T00:00:00.000Z'
 ```
 

diff --git a/docs/ja/Plugin.md b/docs/ja/Plugin.md
@@ -270,7 +270,7 @@ dayjs.extend(customParseFormat)
 dayjs('05/02/69 1:02:03 PM -05:00', 'MM/DD/YY H:mm:ss A Z')
 // Returns an instance containing '1969-05-02T18:02:03.000Z'
 
-dayjs('2018 5月 15', { format: 'YYYY MMMM DD', locale: 'ja' })
+dayjs('2018 5月 15', 'YYYY MMMM DD', 'ja')
 // Returns an instance containing '2018-05-15T00:00:00.000Z'
 ```
 

diff --git a/docs/ko/Plugin.md b/docs/ko/Plugin.md
@@ -262,7 +262,7 @@ dayjs.extend(customParseFormat)
 dayjs('05/02/69 1:02:03 PM -05:00', 'MM/DD/YY H:mm:ss A Z')
 // Returns an instance containing '1969-05-02T18:02:03.000Z'
 
-dayjs('2018 5월 15', { format: 'YYYY MMMM DD', locale: 'ko' })
+dayjs('2018 5월 15', 'YYYY MMMM DD', 'ko')
 // Returns an instance containing '2018-05-15T00:00:00.000Z'
 ```
 

diff --git a/docs/pt-br/Plugin.md b/docs/pt-br/Plugin.md
@@ -261,7 +261,7 @@ dayjs.extend(customParseFormat)
 dayjs('05/02/69 1:02:03 PM -05:00', 'MM/DD/YY H:mm:ss A Z')
 // Returns an instance containing '1969-05-02T18:02:03.000Z'
 
-dayjs('2018 Fevereiro 15', { format: 'YYYY MMMM DD', locale: 'pt_br' })
+dayjs('2018 Fevereiro 15', 'YYYY MMMM DD', 'pt_br')
 // Returns an instance containing '2018-02-15T00:00:00.000Z'
 ```
 

diff --git a/docs/zh-cn/Plugin.md b/docs/zh-cn/Plugin.md
@@ -261,7 +261,7 @@ dayjs.extend(customParseFormat)
 dayjs('05/02/69 1:02:03 PM -05:00', 'MM/DD/YY H:mm:ss A Z')
 // Returns an instance containing '1969-05-02T18:02:03.000Z'
 
-dayjs('2018 五月 15', { format: 'YYYY MMMM DD', locale: 'zh_cn' })
+dayjs('2018 五月 15', 'YYYY MMMM DD', 'zh_cn')
 // Returns an instance containing '2018-05-15T00:00:00.000Z'
 ```
 

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,5 +1,5 @@
 export = dayjs;
-declare function dayjs (date?: dayjs.ConfigType, option?: dayjs.OptionType): dayjs.Dayjs
+declare function dayjs (date?: dayjs.ConfigType, option?: dayjs.OptionType, locale?: string): dayjs.Dayjs
 
 declare namespace dayjs {
   export type ConfigType = string | number | Date | Dayjs