Skip to content

TypeScript API / @contentia/decap / ContentiaBackendModuleConfig

Interface: ContentiaBackendModuleConfig ​

The subset of the Decap backend: config block this module reads or builds. Decap's own CmsBackend['name'] type is a closed union that does not include 'contentia', so this interface mirrors the config as written instead of fighting that type.

Indexable ​

ts
[key: string]: unknown

Properties ​

acceptRoles? ​

ts
acceptRoles?: string[];

api_root? ​

ts
api_root?: string;

app_id? ​

ts
app_id?: string;

assets_folder? ​

ts
assets_folder?: string;

Folder in the assets repository that holds the media library. Defaults to media_folder.


auth_endpoint? ​

ts
auth_endpoint?: string;

auth_token_endpoint? ​

ts
auth_token_endpoint?: string;

auth_token_endpoint_content_type? ​

ts
auth_token_endpoint_content_type?: string;

base_url ​

ts
base_url: string;

dev_token? ​

ts
dev_token?: string;

Pre-shared token that skips the PKCE OAuth dance. See ContentiaBackend.devToken.


name ​

ts
name: "contentia";

use_oidc? ​

ts
use_oidc?: boolean;