types

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:42

Options for setting up the configuration.

Type declaration

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

messages

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

messages: Messages;

opts

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

opts: StudioCMSOptions;

pkgName

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

pkgName: string;

pkgVersion

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

pkgVersion: string;

---

Messages

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

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

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

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;

---

ServerStartOptions

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

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

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

Options for starting the server.

Type declaration

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

messages

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

messages: Messages;

pkgName

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

pkgName: string;

pkgVersion

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

pkgVersion: string;

verbose

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

verbose: boolean;