Skip to main content

OvokCmsPage

A page of published documents (the CMS list envelope).

Kind: Type alias
Package: @ovok/core

Import​

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

TypeScript shape​

type OvokCmsPage<T = OvokCmsDocument> = {
docs: T[];
totalDocs: number;
limit: number;
totalPages: number;
page: number;
pagingCounter: number;
hasPrevPage: boolean;
hasNextPage: boolean;
prevPage: number | null;
nextPage: number | null;
};

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

Public members​

MemberTypeDetails
docsT[]—
totalDocsnumber—
limitnumber—
totalPagesnumber—
pagenumber—
pagingCounternumberThe 1-based position of this page's first document in the whole list.
hasPrevPageboolean—
hasNextPageboolean—
prevPagenumber | nullnull on the first page.
nextPagenumber | nullnull on the last page.

Learn the workflow​

Continue with Client Configuration for the workflow context and examples.

Source​

View the declaration in the SDK source.