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

Function useAdminGetUsers

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

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

    Parameters

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

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

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

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

    Parameters

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

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

    • Defined in src/admin/admin.ts:371
  • useAdminGetUsers<
        TData = AdminUsersGetResponse,
        TError = ErrorType<void | DmError>,
    >(
        params?: AdminGetUsersParams,
        options?: {
            query?: Partial<UseQueryOptions<AdminUsersGetResponse, TError, TData>>;
            request?: AxiosRequestConfig;
        },
    ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
  • Type Parameters

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

    Parameters

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

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

    • Defined in src/admin/admin.ts:381

Settings

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

Generated using TypeDoc