Skip to content

Conversation

@filipsobol
Copy link
Contributor

This PR:

  • unifies documentation for the composable,
  • marks deprecated composables in the navigation,
  • adds information about API methods called by individual composable methods and their custom query keys.

bartoszherba
bartoszherba previously approved these changes May 16, 2022
/**
* Indicates whether any of the methods is in progress
*/
loading: DeepReadonly<Ref<boolean>>,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
loading: DeepReadonly<Ref<boolean>>,
loading: Readonly<Ref<boolean>>,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The @nuxtjs/composition-api package doesn't export the Readonly type

@@ -1,20 +1,32 @@
import { ComputedRef, DeepReadonly, Ref } from '@nuxtjs/composition-api';
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
import { ComputedRef, DeepReadonly, Ref } from '@nuxtjs/composition-api';
import { ComputedRef, Readonly, Ref } from '@nuxtjs/composition-api';

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The @nuxtjs/composition-api package doesn't export the Readonly type

@bartoszherba bartoszherba merged commit 7171038 into develop May 16, 2022
@bartoszherba bartoszherba deleted the 20220511-update-composables-docs branch May 16, 2022 11:35
@Frodigo Frodigo added this to the 1.0.0-rc.8 milestone May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants