consts

Type Aliases

'Read the “', Type Aliases, '” section'

CurrentRESTAPIVersions

'Read the “', CurrentRESTAPIVersions, '” section'

type CurrentRESTAPIVersions = typeof currentRESTAPIVersions[number];

Defined in: studiocms/packages/studiocms/src/consts.ts:32

Current REST API Versions Type

---

StudioCMSSocials

'Read the “', StudioCMSSocials, '” section'

type StudioCMSSocials = {
  discord: string;
  github: string;
  githubContributors: string;
  githubLicense: string;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:58

StudioCMS Social Links Type

Type declaration

'Read the “', Type declaration, '” section'

discord

'Read the “', discord, '” section'

discord: string;

github

'Read the “', github, '” section'

github: string;

githubContributors

'Read the “', githubContributors, '” section'

githubContributors: string;

githubLicense

'Read the “', githubLicense, '” section'

githubLicense: string;

Variables

'Read the “', Variables, '” section'

CMSSiteConfigId

'Read the “', CMSSiteConfigId, '” section'

const CMSSiteConfigId: number = 1;

Defined in: studiocms/packages/studiocms/src/consts.ts:9

StudioCMS Site Config Table Entry ID

---

currentRESTAPIVersions

'Read the “', currentRESTAPIVersions, '” section'

const currentRESTAPIVersions: readonly ["v1"];

Defined in: studiocms/packages/studiocms/src/consts.ts:27

Current REST API Versions

---

defaultCacheLifeTime

'Read the “', defaultCacheLifeTime, '” section'

const defaultCacheLifeTime: TimeString = '5m';

Defined in: studiocms/packages/studiocms/src/consts.ts:16

The default lifetime for cached items. This value is used to determine how long an item should remain in the cache before it is considered expired. This value is used in ./schemas/config/sdk.ts to set the default cache lifetime.

---

GhostUserDefaults

'Read the “', GhostUserDefaults, '” section'

const GhostUserDefaults: {
  avatar: string;
  id: string;
  name: string;
  username: string;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:79

Default values for a “ghost” user in StudioCMS. This user represents a deleted user in the system.

Type declaration

'Read the “', Type declaration, '” section'

avatar

'Read the “', avatar, '” section'

avatar: string = 'https://seccdn.libravatar.org/static/img/mm/80.png';

id

'Read the “', id, '” section'

id: string = '_StudioCMS_Ghost_User_';

name

'Read the “', name, '” section'

name: string = 'Ghost (deleted user)';

username

'Read the “', username, '” section'

username: string = 'studiocms_ghost_user';

---

routesDir

'Read the “', routesDir, '” section'

const routesDir: {
  api: (file: string) => string;
  authAPI: (file: string) => string;
  authPage: (file: string) => string;
  dashApi: (file: string) => string;
  dashRoute: (file: string) => string;
  errors: (file: string) => string;
  fts: (file: string) => string;
  sdk: (file: string) => string;
  v1Rest: (file: string) => string;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:43

REST API Directory

Type declaration

'Read the “', Type declaration, '” section'

api()

'Read the “', api(), '” section'

api: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

authAPI()

'Read the “', authAPI(), '” section'

authAPI: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

authPage()

'Read the “', authPage(), '” section'

authPage: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

dashApi()

'Read the “', dashApi(), '” section'

dashApi: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

dashRoute()

'Read the “', dashRoute(), '” section'

dashRoute: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

errors()

'Read the “', errors(), '” section'

errors: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

fts()

'Read the “', fts(), '” section'

fts: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

sdk()

'Read the “', sdk(), '” section'

sdk: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

v1Rest()

'Read the “', v1Rest(), '” section'

v1Rest: (file: string) => string;

Parameters

'Read the “', Parameters, '” section'

file

'Read the “', file, '” section'

string

Returns

'Read the “', Returns, '” section'

string

---

studioCMSSocials

'Read the “', studioCMSSocials, '” section'

const studioCMSSocials: StudioCMSSocials;

Defined in: studiocms/packages/studiocms/src/consts.ts:68

StudioCMS Social Links

---

versionCacheLifetime

'Read the “', versionCacheLifetime, '” section'

const versionCacheLifetime: number;

Defined in: studiocms/packages/studiocms/src/consts.ts:22

The default lifetime for cached items in milliseconds. This value is used to determine how long an item should remain in the cache before it is considered expired.