@query-api/react
Version:
Craft CMS Query Builder for React
86 lines • 2.31 kB
TypeScript
import { ElementType } from '@query-api/js';
/**
* React hook to fetch data from the Craft API with authentication and custom fetch options.
* Returns an object containing the response data, loading state, and error message (if any).
*/
export declare function useCraftData<ResT = any>(queryUrl: string, options?: RequestInit): {
data: ResT | null;
loading: boolean;
error: string | null;
};
/**
* Returns a query builder for the specified Craft element type.
*/
export declare function useCraftQuery<ResT, T extends ElementType>(elementType: T): import('@query-api/js').QueryBuilder<T> & {
one(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
all(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
};
/**
* Returns a query builder for Craft entries.
*/
export declare function useCraftEntry<ResT = any>(): import('@query-api/js').EntryQueryBuilder & {
one(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
all(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
};
/**
* Returns a query builder for Craft entries.
*/
export declare function useCraftUser<ResT = any>(): import('@query-api/js').UserQueryBuilder & {
one(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
all(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
};
/**
* Returns a query builder for Craft entries.
*/
export declare function useCraftAsset<ResT = any>(): import('@query-api/js').AssetQueryBuilder & {
one(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
all(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
};
/**
* Returns a query builder for Craft entries.
*/
export declare function useCraftAddress<ResT = any>(): import('@query-api/js').AddressQueryBuilder & {
one(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
all(): {
data: ResT | null;
loading: boolean;
error: string | null;
};
};
//# sourceMappingURL=craftFetch.d.ts.map