Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update japanese doc #440

Merged
merged 3 commits into from
Jan 4, 2019
Merged

update japanese doc #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1013395
update japanese doc
butaosuinu Jan 4, 2019
234b325
Merge branch 'master' into ja-doc
butaosuinu Jan 4, 2019
1b81dea
fix table content japanese API-reference doc
butaosuinu Jan 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions docs/ja/API-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Day.js は組み込みの `Date.prototype` を変更する代わりに `Dayjs`
* [Is Before](#is-before)
* [Is Same](#is-same)
* [Is After](#is-after)
* [Is a Dayjs `.isDayjs()`](#is-a-dayjs-isdayjscompared-any)
* [Is a Dayjs](#is-a-dayjs)
* [Plugin APIs](#plugin-apis)
* [RelativeTime](#relativetime)
* [IsLeapYear](#isleapyear)
Expand Down Expand Up @@ -317,7 +317,7 @@ dayjs().format('{YYYY} MM-DDTHH:mm:ssZ[Z]'); // "{2014} 09-08T08:02:17-05:00Z"
| `D` | 1-31 | 日 |
| `DD` | 01-31 | 2桁の日 |
| `d` | 0-6 | 曜日 (日曜は0) |
| `dd` | Su-Sa | The min name of the day of the week |
| `dd` | Su-Sa | 最も短い曜日の略称 |
| `ddd` | Sun-Sat | 曜日の略称 |
| `dddd` | Sunday-Saturday | 曜日名 |
| `H` | 0-23 | 時間 |
Expand All @@ -334,7 +334,7 @@ dayjs().format('{YYYY} MM-DDTHH:mm:ssZ[Z]'); // "{2014} 09-08T08:02:17-05:00Z"
| `A` | AM PM | 午前と午後 (大文字) |
| `a` | am pm | 午前と午後 (小文字) |

* More available formats `Q Do k kk X x ...` in plugin [`AdvancedFormat`](./Plugin.md#advancedformat)
* plugin [`AdvancedFormat`](./Plugin.md#advancedformat) にはより多くのフォーマット（例： `Q Do k kk X x ...` ）が存在します。

#### Difference

Expand Down Expand Up @@ -405,8 +405,6 @@ dayjs().toArray(); //[2018, 8, 18, 00, 00, 00, 000];

* JSON String を返します

Serializing a `Dayjs` object to JSON, will return an ISO8601 string.

`Dayjs` オブジェクトを JSON シリアライズし、ISO8601 形式の日付文字列を返します。

```js
Expand Down Expand Up @@ -482,49 +480,52 @@ dayjs().isAfter(dayjs()); // false
dayjs().isAfter(dayjs(), 'year'); // false
```

### Is a Dayjs `.isDayjs(compared: any)`
#### Is a Dayjs
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should update the table of contents accordingly, to ensure the anchor works.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, fixed.


* Boolean を返します

Returns a `boolean` indicating whether a variable is a dayjs object or not.
与えられた値が `Dayjs` オブジェクトであるかどうかを判定します。

```js
dayjs.isDayjs(compared: any);
dayjs.isDayjs(dayjs()); // true
dayjs.isDayjs(new Date()); // false
```

## Plugin APIs
### Plugin APIs

### RelativeTime
#### RelativeTime

`.from` `.to` `.fromNow` `.toNow` to get relative time
`.from` `.to` `.fromNow` `.toNow` は相対的な時刻を返します。

plugin [`RelativeTime`](./Plugin.md#relativetime)

### IsLeapYear
#### IsLeapYear

`.isLeapYear` to get is a leap year or not
`.isLeapYear` はうるう年かどうかを返します。

plugin [`IsLeapYear`](./Plugin.md#isleapyear)

### WeekOfYear
#### WeekOfYear

`.week` to get week of the year
`.week` はその年の何週目かを返します。

plugin [`WeekOfYear`](./Plugin.md#weekofyear)

### IsSameOrAfter
#### IsSameOrAfter

`.isSameOrAfter` to check if a date is same of after another date
`.isSameOrAfter` はある日付が別の日付と同じまたは以降かどうかを判定します。

plugin [`IsSameOrAfter`](./Plugin.md#issameorafter)

### IsSameOrBefore
#### IsSameOrBefore

`.isSameOrBefore` to check if a date is same of before another date.
`.isSameOrBefore` はある日付が別の日付と同じまたは以前かどうか判定します。

plugin [`IsSameOrBefore`](./Plugin.md#issameorbefore)

### IsBetween
#### IsBetween

`.isBetween` to check if a date is between two other dates
`.isBetween` はある日付が別の2つの日付の間にあるかどうかを判定します。

plugin [`IsBetween`](./Plugin.md#isbetween)
47 changes: 28 additions & 19 deletions docs/ja/Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ dayjs().format('Q Do k kk X x')

追加されるフォーマットの一覧:

| Format | Output | Description |
| フォーマット | 出力 | 説明 |
| ------ | ---------------- | ------------------------------------- |
| `Q` | 1-4 | 四半期 |
| `Do` | 1st 2nd ... 31st | 序数付きの日 |
Expand All @@ -67,7 +67,7 @@ dayjs().format('Q Do k kk X x')
| `x` | 1360013296123 | Unix タイムスタンプ (ミリ秒) |

### RelativeTime
- RelativeTime adds `.from` `.to` `.fromNow` `.toNow` APIs to formats date to relative time strings (e.g. 3 hours ago).
- RelativeTime は日付を文字列で表現された相対的な時刻(例： 3 hours ago)にフォーマットする `.from` `.to` `.fromNow` `.toNow` APIを追加します。

```javascript
import relativeTime from 'dayjs/plugin/relativeTime'
Expand All @@ -86,19 +86,27 @@ dayjs().toNow()

#### Time from now `.fromNow(withoutSuffix?: boolean)`

Returns the `string` of relative time from now.
* String を返します

ある日付から現在を見た時の相対的な時刻を返します。

#### Time from X `.from(compared: Dayjs, withoutSuffix?: boolean)`

Returns the `string` of relative time from X.
* String を返します

ある日付から引数として渡した日付を見た時の相対的な時刻を返します。

#### Time to now `.toNow(withoutSuffix?: boolean)`

Returns the `string` of relative time to now.
* String を返します

現在からある日付を見た時の相対的な時刻を返します。

#### Time to X `.to(compared: Dayjs, withoutSuffix?: boolean)`

Returns the `string` of relative time to X.
* String を返します

引数として渡した日付からある日付を見た時の相対的な時刻を返します。

| Range | Key | Sample Output |
| ------------------------ | ---- | -------------------------------- |
Expand All @@ -115,7 +123,7 @@ Returns the `string` of relative time to X.
| 18 months+ | yy | 2 years ago ... 20 years ago |

### IsLeapYear
- IsLeapYear adds `.isLeapYear` API to returns a `boolean` indicating whether the `Dayjs`'s year is a leap year or not.
- IsLeapYear はある `Dayjs` オブジェクトがうるう年かどうかを Boolean で返す `.isLeapYear` APIを追加します。

```javascript
import isLeapYear from 'dayjs/plugin/isLeapYear'
Expand All @@ -126,9 +134,10 @@ dayjs('2000-01-01').isLeapYear(); // true
```

### BuddhistEra
- BuddhistEra extends `dayjs().format` API to supply Buddhist Era (B.E.) format options.
- Buddhist Era is a year numbering system that primarily used in mainland Southeast Asian countries of Cambodia, Laos, Myanmar and Thailand as well as in Sri Lanka and Chinese populations of Malaysia and Singapore for religious or official occasions ([Wikipedia](https://en.wikipedia.org/wiki/Buddhist_calendar))
- To calculate BE year manually, just add 543 to year. For example 26 May 1977 AD/CE should display as 26 May 2520 BE (1977 + 543)
- BuddhistEra は仏滅紀元 (仏暦、B.E.) を表現するフォーマットを提供するために `dayjs().format` API を拡張します。
- 仏滅紀元（ぶつめつきげん、英：Buddhist calendar）とは、釈迦が入滅したとされる年、またはその翌年を元年とする紀年法である。
仏暦（ぶつれき）ともいう。東南アジアの仏教徒の多い国などで用いられている。([Wikipedia](https://ja.wikipedia.org/wiki/%E4%BB%8F%E6%BB%85%E7%B4%80%E5%85%83))
- 手動で仏暦を計算するには、ちょうど543を年に足します。例として西暦1977年5月26日は仏暦2520年5月26日と表示されます。(1977 + 543)

```javascript
import buddhistEra from 'dayjs/plugin/buddhistEra'
Expand All @@ -138,15 +147,15 @@ dayjs.extend(buddhistEra)
dayjs().format('BBBB BB')
```

List of added formats:
追加されるフォーマットの一覧:

| Format | Output | Description |
| ------ | ---------------- | ------------------------------------- |
| `BBBB` | 2561 | Full BE Year (Year + 543) |
| `BB` | 61 | 2-digit of BE Year |
| フォーマット | 出力 | 説明 |
| --------- | ---- | ------------------ |
| `BBBB` | 2561 | 完全な仏暦 (年 + 543) |
| `BB` | 61 | 2桁の仏暦 |

### WeekOfYear
- WeekOfYear adds `.week()` API to returns a `number` indicating the `Dayjs`'s week of the year.
- WeekOfYear はある `Dayjs` オブジェクトがその年の何週目であるかを `Number` で返す `.week()` APIを追加します。

```javascript
import weekOfYear from 'dayjs/plugin/weekOfYear'
Expand All @@ -156,7 +165,7 @@ dayjs.extend(weekOfYear)
dayjs('06/27/2018').week() // 26
```
### IsSameOrAfter
- IsSameOrAfter adds `.isSameOrAfter()` API to returns a `boolean` indicating if a date is same of after another date.
- IsSameOrAfter はある日付が別の日付と同じまたはそれ以降であるかどうかを `Boolean` で返す `.isSameOrAfter()` APIを追加します。

```javascript
import isSameOrAfter from 'dayjs/plugin/isSameOrAfter'
Expand All @@ -167,7 +176,7 @@ dayjs('2010-10-20').isSameOrAfter('2010-10-19', 'year');
```

### IsSameOrBefore
- IsSameOrBefore adds `.isSameOrBefore()` API to returns a `boolean` indicating if a date is same of before another date.
- IsSameOrBefore はある日付が別の日付と同じまたはそれ以前であるかどうかを `boolean` で返す `.isSameOrBefore()` APIを追加します。

```javascript
import isSameOrBefore from 'dayjs/plugin/isSameOrBefore'
Expand All @@ -178,7 +187,7 @@ dayjs('2010-10-20').isSameOrBefore('2010-10-19', 'year');
```

### IsBetween
- IsBetween adds `.isBetween()` API to returns a `boolean` indicating if a date is between two other dates.
- IsBetween はある日付が別の2つの日付の間にあるかどうかを `Boolean` で返す `.isBetween()` APIを追加します。

```javascript
import isBetween from 'dayjs/plugin/isBetween'
Expand Down