componentRegistry/types

Interfaces

AstroComponentProp

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:23^

Represents a property of an Astro component.

Properties

defaultValue?

readonly optional defaultValue: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:28^

An optional default value for the property.

description?

readonly optional description: string;

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

An optional description of the property.

jsDocTags?

readonly optional jsDocTags: JSDocTag[];

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

name

readonly name: string;

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

The name of the property.

optional

readonly optional: boolean;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:26^

Indicates whether the property is optional.

type

readonly type: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:25^

The type of the property as a string.

---

AstroComponentProps

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:38^

Represents the properties of an Astro component.

Extended by

• ComponentRegistryEntry

Properties

name

readonly name: string;

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

The unique name of the Astro component.

props

readonly props: readonly AstroComponentProp[];

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

A readonly array of properties (AstroComponentProp) associated with the component.

---

ComponentRegistryEntry

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:50^

Represents an entry in the component registry.

Extends the AstroComponentProps interface to include additional metadata.

Extends

• AstroComponentProps

Properties

name

readonly name: string;

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

The unique name of the Astro component.

Inherited from

AstroComponentProps.name

props

readonly props: readonly AstroComponentProp[];

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

A readonly array of properties (AstroComponentProp) associated with the component.

Inherited from

AstroComponentProps.props

safeName

readonly safeName: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:51^

A readonly string representing a safe, unique identifier for the component.

---

JSDocTag

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:7^

Represents a JSDoc tag with its name and optional text content.

Properties

name?

optional name: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:10^

tagName

tagName: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:8^

The name of the JSDoc tag (e.g., ‘param’, ‘returns’).

text?

optional text: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:9^

Optional text associated with the tag, such as a description or type.

type?

optional type: string;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:11^

---

PropValidationResult

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:60^

Represents the result of validating a set of properties.

Properties

errors

readonly errors: readonly string[];

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:62^

A readonly array of error messages describing validation failures.

valid

readonly valid: boolean;

Defined in: studiocms/packages/studiocms/src/componentRegistry/types.ts:61^

Indicates whether the validation was successful.