@umbraco/headless-client
Version:
Node.js client library for the Umbraco Headless APIs
35 lines (34 loc) • 1.14 kB
TypeScript
import { Client } from '../../Client';
import { ContentDeliveryRedirectOptions } from '../../RequestOptions';
import { Redirect } from '../../Responses/Redirect';
/**
* RedirectDeliveryClient is used to access the Redirect part of the Content Delivery API.
* @public
*
* @example
* The {@link RedirectDeliveryClient} must be accessed through {@link Client}.
*
* ```typescript
* import { Client } from '@umbraco/headless-client'
*
* const client = new Client({
* projectAlias: '<your-project-alias>',
* apiKey: '<your-api-key>',
* language: '<iso-code>',
* })
*
* const mediaClient = client.delivery.redirect
* ```
*/
export declare class RedirectDeliveryClient {
private readonly client;
/** @internal **/
constructor(client: Client);
private readonly makeRequest;
/**
* Fetch all redirects
* @param options - Request options. See {@link ContentDeliveryRedirectOptions}
* @returns a `Promise` that resolves to a {@link PagedResponse} of {@link Redirect}
*/
getAll<T extends Redirect>(options?: ContentDeliveryRedirectOptions): Promise<import("../..").PagedResponse<T>>;
}