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

docs: change type for unableAutoUnmount #1966

Merged
merged 3 commits into from
Feb 10, 2023
+2 −2
Merged

docs: change type for unableAutoUnmount #1966

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdb9afd
Update index.md
voskresla Feb 6, 2023
1f9cc31
refactor(autoUnmount): update types
voskresla Feb 8, 2023
15eeaba
docs: fix types
voskresla Feb 10, 2023
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
2 changes: 1 addition & 1 deletion docs/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1886,7 +1886,7 @@ function shallowMount(Component, options?: MountingOptions): VueWrapper
**Signature:**

```ts
enableAutoUnmount(hook: Function));
enableAutoUnmount(hook: (callback: Function) => void));
Copy link
Member

Choose a reason for hiding this comment

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

Maybe even hook: (callback: () => void) => void?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will update types, thx.

Copy link
Member

Choose a reason for hiding this comment

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

To be coherent, maybe change the type here in the docs as well to be the same as the TS types?

disableAutoUnmount(): void;
```

Expand Down
2 changes: 1 addition & 1 deletion src/utils/autoUnmount.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export function disableAutoUnmount() {
wrapperInstances.length = 0
}

export function enableAutoUnmount(hook: Function) {
export function enableAutoUnmount(hook: (callback: () => void) => void) {
if (isEnabled) {
throw new Error('enableAutoUnmount cannot be called more than once')
}
Expand Down