Skip to content

Commit ef5bc3c

Browse files
eddyerburghkazupon
authored andcommitted
docs: remove sync mode from docs (#1142)
* docs: remove sync mode * docs: remove TransitionGroupStub and TransitionStub pages * refactor: remove dist dir * docs: tweak
1 parent b05c9d0 commit ef5bc3c

38 files changed

+5
-382
lines changed

Diff for: docs/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Vue Test Utils is the official unit testing utility library for Vue.js.
3232
- [listeners](api/options.md#listeners)
3333
- [parentComponent](api/options.md#parentComponent)
3434
- [provide](api/options.md#provide)
35-
- [sync](api/options.md#sync)
3635
- [other options](api/options.md#other-options)
3736
- [Wrapper](api/wrapper/)
3837
- [attributes](api/wrapper/attributes.md)
@@ -76,8 +75,6 @@ Vue Test Utils is the official unit testing utility library for Vue.js.
7675
- [trigger](api/wrapper-array/trigger.md)
7776
- [isVisible](api/wrapper-array/isVisible.md)
7877
- [components](api/components/)
79-
- [TransitionStub](api/components/TransitionStub.md)
80-
- [TransitionGroupStub](api/components/TransitionGroupStub.md)
8178
- [RouterLinkStub](api/components/RouterLinkStub.md)
8279
- [Selectors](api/selectors.md)
8380
- [createWrapper](api/createWrapper.md)

Diff for: docs/api/components/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
Vue Test Utils includes utility components you can use to stub components.
44

55
!!!include(docs/api/components/RouterLinkStub.md)!!!
6-
!!!include(docs/api/components/TransitionStub.md)!!!
7-
!!!include(docs/api/components/TransitionGroupStub.md)!!!

Diff for: docs/api/components/TransitionGroupStub.md

-31
This file was deleted.

Diff for: docs/api/components/TransitionStub.md

-31
This file was deleted.

Diff for: docs/api/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Vue Test Utils includes a config object to defined options used by Vue Test Util
77
### `stubs`
88

99
- type: `{ [name: string]: Component | boolean | string }`
10-
- default: `{ transition: TransitionStub, 'transition-group': TransitionGroupStub }`
10+
- default: `{}`
1111

1212
The stub stored in `config.stubs` is used by default.
1313
Stubs to use in components. These are overwritten by `stubs` passed in the mounting options.

Diff for: docs/api/createWrapper.md

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
- `{vm|HTMLElement} node`
66
- `{Object} options`
7-
- `{Boolean} sync`
87
- `{Boolean} attachedToDocument`
98

109
- **Returns:**

Diff for: docs/api/options.md

-9
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ These options will be merged with the component's existing options when mounted
2121
- [`listeners`](#listeners)
2222
- [`parentComponent`](#parentcomponent)
2323
- [`provide`](#provide)
24-
- [`sync`](#sync)
2524

2625
## context
2726

@@ -290,14 +289,6 @@ const wrapper = shallowMount(Component, {
290289
expect(wrapper.text()).toBe('fooValue')
291290
```
292291

293-
## sync
294-
295-
- type: `boolean`
296-
- default: `true`
297-
298-
When `sync` is `true`, the Vue component is rendered synchronously.
299-
When `sync` is `false`, the Vue component is rendered asynchronously.
300-
301292
## Other options
302293

303294
When the options for `mount` and `shallowMount` contain the options other than the mounting options, the component options are overwritten with those using [extends](https://vuejs.org/v2/api/#extends).

Diff for: docs/api/wrapper/README.md

-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@ A `Wrapper` is an object that contains a mounted component or vnode and methods
2020

2121
`Boolean` (read-only): True if component is attached to document when rendered.
2222

23-
#### `options.sync`
24-
25-
`Boolean` (read-only): True if `sync` in mounting options was not `false`
26-
2723
## Methods
2824

2925
!!!include(docs/api/wrapper/attributes.md)!!!

Diff for: docs/ja/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
- [listeners](api/options.md#listeners)
3333
- [parentComponent](api/options.md#parentcomponent)
3434
- [provide](api/options.md#provide)
35-
- [sync](api/options.md#sync)
3635
- [その他のオプション](api/options.md#その他のオプション)
3736
- [Wrapper](api/wrapper/)
3837
- [attributes](api/wrapper/attributes.md)
@@ -76,8 +75,6 @@
7675
- [trigger](api/wrapper-array/trigger.md)
7776
- [isVisible](api/wrapper-array/isVisible.md)
7877
- [コンポーネント](api/components/)
79-
- [TransitionStub](api/components/TransitionStub.md)
80-
- [TransitionGroupStub](api/components/TransitionGroupStub.md)
8178
- [RouterLinkStub](api/components/RouterLinkStub.md)
8279
- [セレクタ](api/selectors.md)
8380
- [createWrapper](api/createWrapper.md)

Diff for: docs/ja/api/components/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
vue-test-utils にはコンポーネントをスタブするためのユーティリティコンポーネントがあります。
44

55
!!!include(docs/ja/api/components/RouterLinkStub.md)!!!
6-
!!!include(docs/ja/api/components/TransitionStub.md)!!!
7-
!!!include(docs/ja/api/components/TransitionGroupStub.md)!!!

Diff for: docs/ja/api/components/TransitionGroupStub.md

-31
This file was deleted.

Diff for: docs/ja/api/components/TransitionStub.md

-31
This file was deleted.

Diff for: docs/ja/api/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ vue-test-utils にはオプションを定義するための `config` オプシ
77
#### `stubs`
88

99
- 型: `{ [name: string]: Component | boolean | string }`
10-
- デフォルト: `{ transition: TransitionStub, 'transition-group': TransitionGroupStub }`
10+
- デフォルト: `{}`
1111

1212
コンポーネントで使用するスタブはマウンティングオプションの `stubs` で設定します。
1313

Diff for: docs/ja/api/createWrapper.md

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
- `{vm|HTMLElement} node`
66
- `{Object} options`
7-
- `{Boolean} sync`
87
- `{Boolean} attachedToDocument`
98

109
- **戻り値:**

Diff for: docs/ja/api/options.md

-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
- [`listeners`](#listeners)
1515
- [`parentComponent`](#parentcomponent)
1616
- [`provide`](#provide)
17-
- [`sync`](#sync)
1817

1918
## context
2019

@@ -276,14 +275,6 @@ const wrapper = shallowMount(Component, {
276275
expect(wrapper.text()).toBe('fooValue')
277276
```
278277

279-
## sync
280-
281-
- 型: `boolean`
282-
- デフォルト: `true`
283-
284-
`sync``true` にすると、Vue コンポーネントは同期的に描画されます。
285-
`sync``false` にすると、Vue コンポーネントは非同期的に描画されます。
286-
287278
## その他のオプション
288279

289280
`mount` と  `shallowMount` にマウンティングオプション以外のオプションが渡されると、コンポーネントのオプションは [extends](https://vuejs.org/v2/api/#extends) を使ってマウンティングオプション以外のオプションに上書きされます。

Diff for: docs/ja/api/wrapper/README.md

-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@ vue-test-utils はラッパベースの API です。
2020

2121
`Boolean` (読み込み専用): マウンティングオプションで `attachToDocument``true` だった場合は True です。
2222

23-
#### `options.sync`
24-
25-
`Boolean` (読み込み専用): マウンティングオプションで `sync``false` ではなかった場合は True です。
26-
2723
## メソッド
2824

2925
!!!include(docs/ja/api/wrapper/attributes.md)!!!

Diff for: docs/ru/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Vue Test Utils — официальная библиотека модульно
3232
- [listeners](api/options.md#listeners)
3333
- [parentComponent](api/options.md#parentComponent)
3434
- [provide](api/options.md#provide)
35-
- [sync](api/options.md#sync)
3635
- [другие опции](api/options.md#другие-опции)
3736
- [Wrapper](api/wrapper/)
3837
- [attributes](api/wrapper/attributes.md)
@@ -76,8 +75,6 @@ Vue Test Utils — официальная библиотека модульно
7675
- [trigger](api/wrapper-array/trigger.md)
7776
- [isVisible](api/wrapper-array/isVisible.md)
7877
- [Компоненты](api/components/)
79-
- [TransitionStub](api/components/TransitionStub.md)
80-
- [TransitionGroupStub](api/components/TransitionGroupStub.md)
8178
- [RouterLinkStub](api/components/RouterLinkStub.md)
8279
- [Селекторы](api/selectors.md)
8380
- [createWrapper](api/createWrapper.md)

Diff for: docs/ru/api/components/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
Vue Test Utils включает утилиты, которые вы можете использовать для создания заглушек компонентов.
44

55
!!!include(docs/ru/api/components/RouterLinkStub.md)!!!
6-
!!!include(docs/ru/api/components/TransitionStub.md)!!!
7-
!!!include(docs/ru/api/components/TransitionGroupStub.md)!!!

Diff for: docs/ru/api/components/TransitionGroupStub.md

-31
This file was deleted.

Diff for: docs/ru/api/components/TransitionStub.md

-31
This file was deleted.

Diff for: docs/ru/api/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Vue Test Utils включает объект конфигурации для о
77
### `stubs`
88

99
- Тип: `{ [name: string]: Component | boolean | string }`
10-
- По умолчанию: `{ transition: TransitionStub, 'transition-group': TransitionGroupStub }`
10+
- По умолчанию: `{}`
1111

1212
Заглушки указанные в `config.stubs` используются по умолчанию.
1313
Заглушки, используемые в компонентах. Они перезаписываются значениями `stubs` переданными в настройках монтирования.

Diff for: docs/ru/api/options.md

-9
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
- [listeners](#listeners)
2323
- [parentComponent](#parentcomponent)
2424
- [provide](#provide)
25-
- [sync](#sync)
2625
- [Другие опции](#%D0%B4%D1%80%D1%83%D0%B3%D0%B8%D0%B5-%D0%BE%D0%BF%D1%86%D0%B8%D0%B8)
2726

2827
## context
@@ -292,14 +291,6 @@ const wrapper = shallowMount(Component, {
292291
expect(wrapper.text()).toBe('fooValue')
293292
```
294293

295-
## sync
296-
297-
- Тип: `boolean`
298-
- По умолчанию: `true`
299-
300-
Когда `sync` равняется `true`, Vue-компонент рендерится синхронно.
301-
Когда `sync` равняется `false`, Vue-компонент рендерится асинхронно.
302-
303294
## Другие опции
304295

305296
Если в параметрах для `mount` и `shallowMount` содержатся другие опции, отличные от опций монтирования, опции компонента будут перезаписаны с помощью [extends](https://ru.vuejs.org/v2/api/#extends).

0 commit comments

Comments
 (0)