@oarepo/invenio-vue
Version:
Vue 3 library for handling invenio REST
15 lines (14 loc) • 917 B
TypeScript
/**
* Invenio collection getter. When the collection is loaded, performs extra OPTIONS call
* to get collection options - human name, facets, filters, etc...
*
* The options are cached and re-fetched once a day
*
* @param baseUrl the base url of invenio API server
* @param httpGetOptions extra options for listing request
* @param httpOptionOptions extra options for HTTP options request
* @returns composable UseInvenioCollectionComposable
*/
import { HttpError, HttpQuery } from "../http";
import { InvenioCollectionComposable, InvenioCollectionOptions, JsonType } from "./types";
export declare function useInvenioCollection<CollectionRecord extends JsonType, ErrorType extends HttpError>(url: string, initialQuery?: HttpQuery, options?: InvenioCollectionOptions<CollectionRecord, ErrorType>): InvenioCollectionComposable<CollectionRecord, ErrorType>;