Skip to main content

Function: isContentClassName()

function isContentClassName(className): className is string;

Defined in: packages/client/src/core/content-transfer.ts:46

Reports whether a class name belongs to application content.

DocStack names everything it owns with a leading ~ - ~User, ~Group, ~Policy, ~Job, ~JobRun, ~UserSession, ~AuthModule, ~lock - and reserves the handful of unprefixed names in META_CLASSES for the datamodel itself. Everything else was created by an application.

Parameters

ParameterTypeDescription
classNameunknownA ~class value or class-model id.

Returns

className is string

Example

isContentClassName("Task"); // true
isContentClassName("~User"); // false - DocStack's own
isContentClassName("class"); // false - a class model