@umbraco/headless-client
Version:
Node.js client library for the Umbraco Headless APIs
44 lines (43 loc) • 1.25 kB
TypeScript
import { Client } from '../../Client';
import { ContentDeliveryClient } from './ContentDeliveryClient';
import { MediaDeliveryClient } from './MediaDeliveryClient';
import { RedirectDeliveryClient } from './RedirectDeliveryClient';
/**
* DeliveryClient used to access the Content Delivery API.
* @public
*
* @example
* The {@link DeliveryClient} 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 deliveryClient = client.delivery
* ```
*/
export declare class DeliveryClient {
private readonly client;
/**
* The Content client for the Content Delivery API.
* See {@link ContentDeliveryClient}
*/
readonly content: ContentDeliveryClient;
/**
* The Media client for the Content Delivery API.
* See {@link MediaDeliveryClient}
*/
readonly media: MediaDeliveryClient;
/**
* The Redirect client for the Content Delivery API.
* See {@link RedirectDeliveryClient}
*/
readonly redirect: RedirectDeliveryClient;
/** @internal */
constructor(client: Client);
}