• Preparing search index...
  • The search index is not available
@squonk/data-manager-client
  • @squonk/data-manager-client
  • project/project
  • useGetProjects

Function useGetProjects

  • useGetProjects<TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(
        params: undefined | GetProjectsParams,
        options: {
            query: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData>> & Pick<
                DefinedInitialDataOptions<ProjectsGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = ProjectsGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • params: undefined | GetProjectsParams
    • options: {
          query: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData>> & Pick<
              DefinedInitialDataOptions<ProjectsGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

    Returns DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/project/project.ts:95
  • useGetProjects<TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(
        params?: GetProjectsParams,
        options?: {
            query?: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData>> & Pick<
                UndefinedInitialDataOptions<ProjectsGetResponse, TError, TData>,
                "initialData",
            >;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = ProjectsGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • Optionalparams: GetProjectsParams
    • Optionaloptions: {
          query?: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData>> & Pick<
              UndefinedInitialDataOptions<ProjectsGetResponse, TError, TData>,
              "initialData",
          >;
          request?: AxiosRequestConfig;
      }

    Returns UseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/project/project.ts:105
  • useGetProjects<TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(
        params?: GetProjectsParams,
        options?: {
            query?: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData>>;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

    • TData = ProjectsGetResponse
    • TError = ErrorType<void | DmError>

    Parameters

    • Optionalparams: GetProjectsParams
    • Optionaloptions: {
          query?: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData>>;
          request?: AxiosRequestConfig;
      }

    Returns UseQueryResult<TData, TError> & { queryKey: QueryKey }

    • Defined in src/project/project.ts:115

Settings

Member Visibility
@squonk/data-manager-client
  • Loading...

Generated using TypeDoc