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

fix liveMode prop type docs #1293

Merged
merged 1 commit into from
Dec 8, 2021
Merged

fix liveMode prop type docs #1293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 documentation/docs/api-references/hooks/data/useList.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ const postListQueryResult = useList<IPost>({
| successNotification | Successful Query notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | `false` |
| errorNotification | Unsuccessful Query notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | "Error (status code: `statusCode`)" |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/api-references/hooks/data/useMany.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ After query runs, the `categoryQueryResult` will include the retrieved data:
| successNotification | Successful Query notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | `false` |
| errorNotification | Unsuccessful Query notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | "Error (status code: `statusCode`)" |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/api-references/hooks/data/useOne.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ After query runs, the `categoryQueryResult` will include the retrieved data:
| successNotification | Successful Query notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | `false` |
| errorNotification | Unsuccessful Query notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | "Error (status code: `statusCode`)" |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/api-references/hooks/field/useCheckboxGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ const { checkboxGroupProps } = useCheckboxGroup({
| sort | Allows us to sort the options | [`CrudSorting`](../../interfaces.md#crudsorting) | |
| queryOptions | react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options | ` UseQueryOptions<GetListResponse<TData>, TError>` | |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/api-references/hooks/field/useRadioGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ const { radioGroupProps } = useRadioGroup({
| sort | Allows us to sort the options | [`CrudSorting`](../../interfaces.md#crudsorting) | |
| queryOptions | react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options | ` UseQueryOptions<GetListResponse<TData>, TError>` | |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/api-references/hooks/field/useSelect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ const { selectProps } = useSelect({
| queryOptions | react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options | ` UseQueryOptions<GetListResponse<TData>, TError>` | |
| defaultValueQueryOptions | react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options | ` UseQueryOptions<GetManyResponse<TData>, TError>` | |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/api-references/hooks/form/useDrawerForm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ The `saveButtonProps` and `deleteButtonProps` gives us the ability of saving and
| successNotification | Successful Mutation notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | "Successfully created `resource`" or "Successfully updated `resource`" |
| errorNotification | Unsuccessful Mutation notification | [`SuccessErrorNotification`](../../interfaces.md#successerrornotification) | "There was an error creating `resource` (status code: `statusCode`)" or "Error when updating `resource` (status code: `statusCode`)" |
| metaData | Metadata query for `dataProvider` | [`MetaDataQuery`](/api-references/interfaces.md#metadataquery) | {} |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [``"auto"` \| `"manual"` \| `"off"``](/api-references/interfaces.md#livemodeprops) | `"off"` |
| [liveMode](/api-references/providers/live-provider.md#usage-in-a-hook) | Whether to update data automatically (`"auto"`) or not (`"manual"`) if a related live event is received. The "off" value is used to avoid creating a subscription. | [`"auto"` \| `"manual"` \| `"off"`](/api-references/interfaces.md#livemodeprops) | `"off"` |
| liveParams | Params to pass to `liveProvider`'s `subscribe` method if `liveMode` is enabled. | [`{ ids?: string[]; [key: string]: any; }`](/api-references/interfaces.md#livemodeprops) | `undefined` |
| onLiveEvent | Callback to handle all related live events of this hook. | [`(event: LiveEvent) => void`](/api-references/interfaces.md#livemodeprops) | `undefined` |

Expand Down
Loading