Interface CreateClientParams

Client initialization parameters

interface CreateClientParams {
    accessToken: string;
    adapter?: AxiosAdapter;
    alphaFeatures?: {
        includeContentSourceMaps?: boolean;
        timelinePreview?: TimelinePreview;
    };
    application?: string;
    basePath?: string;
    environment?: string;
    headers?: Record<string, string>;
    host?: string;
    httpAgent?: any;
    httpsAgent?: any;
    includeContentSourceMaps?: boolean;
    insecure?: boolean;
    integration?: string;
    logHandler?: ((level: string, data?: string | Record<string, any>) => void);
    proxy?: false | AxiosProxyConfig;
    requestLogger?: ((request: Error | AxiosRequestConfig<any>) => unknown);
    responseLogger?: ((response: Error | AxiosResponse<any, any, {}>) => unknown);
    retryLimit?: number;
    retryOnError?: boolean;
    space: string;
    timeout?: number;
}

Properties

accessToken adapter? alphaFeatures? application? basePath? environment? headers? host? httpAgent? httpsAgent? includeContentSourceMaps? insecure? integration? logHandler? proxy? requestLogger? responseLogger? retryLimit? retryOnError? space timeout?

Properties

accessToken

accessToken: string

Contentful CDA Access Token

Optionaladapter

adapter?: AxiosAdapter

Optional axios request adapter (see axios docs )

OptionalalphaFeatures

alphaFeatures?: {
    includeContentSourceMaps?: boolean;
    timelinePreview?: TimelinePreview;
}

Enable alpha features.

Type declaration

  • OptionalincludeContentSourceMaps?: boolean

    Deprecated

    Use the includeContentSourceMaps option directly instead.

  • OptionaltimelinePreview?: TimelinePreview

    Enable Timeline Preview.

    Remarks

    This feature is only available in private beta when using the Content Preview API.

Optionalapplication

application?: string

Application name and version e.g myApp/version

OptionalbasePath

basePath?: string

Path appended to the host to support gateways/proxies with custom urls

Optionalenvironment

environment?: string

Contentful Environment ID

Default Value

"master"

Optionalheaders

headers?: Record<string, string>

Optional additional headers

Optionalhost

host?: string

API host. Also usable with preview.contentful.com.

Default Value

"cdn.contentful.com"

OptionalhttpAgent

httpAgent?: any

Optional Node.js HTTP agent for proxying (see Node.js docs and https-proxy-agent)

OptionalhttpsAgent

httpsAgent?: any

Optional Node.js HTTP agent for proxying (see Node.js docs and https-proxy-agent)

OptionalincludeContentSourceMaps

includeContentSourceMaps?: boolean

Enable Content Source Maps.

Remarks

This feature is only available when using the Content Preview API.

Optionalinsecure

insecure?: boolean

Requests will be made over http instead of the default https

Default Value

true

Optionalintegration

integration?: string

Integration name and version e.g react/version

OptionallogHandler

logHandler?: ((level: string, data?: string | Record<string, any>) => void)

A log handler function to process given log messages and errors. (The default can be found at: https://github.com/contentful/contentful-sdk-core/blob/master/src/create-http-client.ts)

Type declaration

    • (level, data?): void

    • Parameters

      • level: string

        Log level, e.g. error, warning, or info

      • Optionaldata: string | Record<string, any>

        Log data

      Returns void

Optionalproxy

proxy?: false | AxiosProxyConfig

Optional Axios proxy (see axios docs )

OptionalrequestLogger

requestLogger?: ((request: Error | AxiosRequestConfig<any>) => unknown)

Interceptor called on every request. Takes Axios request config as an arg.

OptionalresponseLogger

responseLogger?: ((response: Error | AxiosResponse<any, any, {}>) => unknown)

Interceptor called on every response. Takes Axios response object as an arg.

OptionalretryLimit

retryLimit?: number

Optional number of retries before failure.

Default Value

5

OptionalretryOnError

retryOnError?: boolean

If we should retry on errors and 429 rate limit exceptions

Default Value

true

space

space: string

Space ID

Optionaltimeout

timeout?: number

connection timeout in milliseconds (default:30000)

Settings

Member Visibility

On This Page

Properties