types

Interfaces

'Read the “', Interfaces, '” section'

PluginPageTypeEditorProps

'Read the “', PluginPageTypeEditorProps, '” section'

Defined in: studiocms/packages/studiocms/src/types.ts:76

Properties

'Read the “', Properties, '” section'

content?

'Read the “', content?, '” section'

optional content: string;

Defined in: studiocms/packages/studiocms/src/types.ts:77

---

PluginPageTypeRendererProps

'Read the “', PluginPageTypeRendererProps, '” section'

Defined in: studiocms/packages/studiocms/src/types.ts:72

Properties

'Read the “', Properties, '” section'

data

'Read the “', data, '” section'

data: DeepPartial<CombinedPageData>;

Defined in: studiocms/packages/studiocms/src/types.ts:73

Type Aliases

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

ConfigSetupOptions

'Read the “', ConfigSetupOptions, '” section'

type ConfigSetupOptions = {
  messages: Messages;
  opts: StudioCMSOptions;
  pkgName: string;
  pkgVersion: string;
};

Defined in: studiocms/packages/studiocms/src/types.ts:54

Options for setting up the configuration.

Properties

'Read the “', Properties, '” section'

messages

'Read the “', messages, '” section'

messages: Messages;

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

The messages to be used.

opts

'Read the “', opts, '” section'

opts: StudioCMSOptions;

Defined in: studiocms/packages/studiocms/src/types.ts:57

The options for StudioCMS.

pkgName

'Read the “', pkgName, '” section'

pkgName: string;

Defined in: studiocms/packages/studiocms/src/types.ts:55

The name of the package.

pkgVersion

'Read the “', pkgVersion, '” section'

pkgVersion: string;

Defined in: studiocms/packages/studiocms/src/types.ts:56

The version of the package.

---

DeepPartial<T>

'Read the “', DeepPartial&lt;T&gt;, '” section'

type DeepPartial<T> = { [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P] };

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

A utility type that recursively makes all properties of a given type T optional.

This is particularly useful for creating partial versions of deeply nested objects.

Type Parameters

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

T

'Read the “', T, '” section'

T

The type to be transformed into a deep partial.

---

Messages

'Read the “', Messages, '” section'

type Messages = {
  label: string;
  logLevel: "info" | "warn" | "error" | "debug";
  message: string;
 }[];

Defined in: studiocms/packages/studiocms/src/types.ts:15

Represents an array of message objects. Each message object contains information about a log message.

Type declaration

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

label

'Read the “', label, '” section'

label: string;

logLevel

'Read the “', logLevel, '” section'

logLevel: "info" | "warn" | "error" | "debug";

message

'Read the “', message, '” section'

message: string;

---

Route

'Read the “', Route, '” section'

type Route = InjectedRoute & {
  enabled: boolean;
};

Defined in: studiocms/packages/studiocms/src/types.ts:24

Represents a route object that can be used for a Array of routes for the Astro integration injectRoute() function.

Type declaration

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

enabled

'Read the “', enabled, '” section'

enabled: boolean;

---

Script

'Read the “', Script, '” section'

type Script = {
  content: string;
  enabled: boolean;
  stage: InjectedScriptStage;
};

Defined in: studiocms/packages/studiocms/src/types.ts:29

Represents a script object that can be used for a Array of scripts for the Astro integration injectScript() function.

Properties

'Read the “', Properties, '” section'

content

'Read the “', content, '” section'

content: string;

Defined in: studiocms/packages/studiocms/src/types.ts:29

enabled

'Read the “', enabled, '” section'

enabled: boolean;

Defined in: studiocms/packages/studiocms/src/types.ts:29

stage

'Read the “', stage, '” section'

stage: InjectedScriptStage;

Defined in: studiocms/packages/studiocms/src/types.ts:29

---

ServerStartOptions

'Read the “', ServerStartOptions, '” section'

type ServerStartOptions = {
  messages: Messages;
  pkgName: string;
  pkgVersion: string;
  verbose: boolean;
};

Defined in: studiocms/packages/studiocms/src/types.ts:39

Options for starting the server.

Properties

'Read the “', Properties, '” section'

messages

'Read the “', messages, '” section'

messages: Messages;

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

The messages configuration.

pkgName

'Read the “', pkgName, '” section'

pkgName: string;

Defined in: studiocms/packages/studiocms/src/types.ts:40

The name of the package.

pkgVersion

'Read the “', pkgVersion, '” section'

pkgVersion: string;

Defined in: studiocms/packages/studiocms/src/types.ts:41

The version of the package.

verbose

'Read the “', verbose, '” section'

verbose: boolean;

Defined in: studiocms/packages/studiocms/src/types.ts:42

Flag to enable verbose logging.