OvokCmsDocument

A published document of an Ovok CMS collection (legal-pages, release-notes, …). Fields beyond these depend on the collection.

Kind: Type alias
Package: @ovok/core

Import

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

TypeScript shape

type OvokCmsDocument = {
    id: number | string;
    slug?: string | null;
    title?: string | null;
    excerpt?: string | null;
    body?: unknown;
    tags?: string[] | null;
    status: string;
    publishedAt?: string | null;
    effectiveAt?: string | null;
    updatedAt?: string | null;
    [field: string]: unknown;
};

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

Public members

Member	Type	Details
id	number | string	—
slug	string | null	Optional. —
title	string | null	Optional. —
excerpt	string | null	Optional. —
body	unknown	Optional. Lexical rich text (JSON), as the CMS stores it.
tags	string[] | null	Optional. —
status	string	—
publishedAt	string | null	Optional. —
effectiveAt	string | null	Optional. —
updatedAt	string | null	Optional. —

Learn the workflow

Continue with Client Configuration for the workflow context and examples.

Source

View the declaration in the SDK source.