types

Interfaces

PluginPageTypeEditorProps

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

Properties

content?

optional content: string;

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

---

PluginPageTypeRendererProps

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

Properties

data

data: DeepPartial<CombinedPageData>;

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

Type Aliases

ConfigSetupOptions

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

messages

messages: Messages;

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

The messages to be used.

opts

opts: StudioCMSOptions;

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

The options for StudioCMS.

pkgName

pkgName: string;

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

The name of the package.

pkgVersion

pkgVersion: string;

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

The version of the package.

---

DeepPartial<T>

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

T

T

The type to be transformed into a deep partial.

---

Messages

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

label

label: string;

logLevel

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

message

message: string;

---

Route

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

enabled

enabled: boolean;

---

Script

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

content

content: string;

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

enabled

enabled: boolean;

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

stage

stage: InjectedScriptStage;

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

---

ServerStartOptions

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

messages

messages: Messages;

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

The messages configuration.

pkgName

pkgName: string;

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

The name of the package.

pkgVersion

pkgVersion: string;

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

The version of the package.

verbose

verbose: boolean;

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

Flag to enable verbose logging.