Skip to content

TypeScript API / laikacms/catalog-api / CatalogApiOptions

Interface: CatalogApiOptions ​

Properties ​

authorize ​

ts
authorize: CatalogAuthorize;

Per-action authorization hook. Required: there is no implicit default, because an API that silently defaults to open is the failure mode this option exists to prevent. Pass allowAll to state that a surface is intentionally unauthenticated. See CatalogAuthorize.


basePath? ​

ts
optional basePath?: string;

Mount prefix advertised in the served OpenAPI document's servers URL. Strip this same prefix from incoming request paths before routing.


logger? ​

ts
optional logger?: JsonApiLogger;

repo ​

ts
repo: CatalogProvider;

Methods ​

onError()? ​

ts
optional onError(error): void;

Parameters ​

ParameterType
errorunknown

Returns ​

void

Released under the MIT License.