OvokCmsOptions

No behavioral description is attached to this declaration. The public signature, parameter and return types, and source location below document its published contract.

Kind: Type alias
Package: @ovok/core

Import

import { OvokCmsOptions } from '@ovok/core';

TypeScript shape

type OvokCmsOptions = {
    locale?: string;
    tenantCode?: string;
    environment?: "dev" | "staging" | "prod";
    allowSignedOut?: boolean;
};

This is a type-level export; it has no call parameters.

Public members

Member	Type	Details
locale	string	Optional. An app language ("de-DE") or a CMS locale ("de"), mapped with toCmsLocale. Omitted or "", the CMS answers in its default locale; the hooks send the runtime's language instead.
tenantCode	string	Optional. The tenant's code. Signed out, a read needs this and allowSignedOut. Signed in, the session's own tenant is read; naming another tenant is refused (403).
environment	"dev" | "staging" | "prod"	Optional. Omitted, the backend's own.
allowSignedOut	boolean	Optional. —

Learn the workflow

Continue with Client Configuration for the workflow context and examples.

Source

View the declaration in the SDK source.