types

Type Aliases

HeadConfig

type HeadConfig = {
  attrs: Record<string, string | boolean | undefined>;
  content: string;
  tag:   | "title"
     | "base"
     | "link"
     | "style"
     | "meta"
     | "script"
     | "noscript"
     | "template";
}[];

Defined in: studiocms/packages/@studiocms/blog/src/types.ts:6^

Type Declaration

attrs

attrs: Record<string, string | boolean | undefined>;

content

content: string;

tag

tag:
  | "title"
  | "base"
  | "link"
  | "style"
  | "meta"
  | "script"
  | "noscript"
  | "template";

---

HeadUserConfig

type HeadUserConfig =
  | undefined
  | {
  attrs?: Record<string, undefined | string | boolean>;
  content?: string;
  tag:   | "title"
     | "base"
     | "link"
     | "style"
     | "meta"
     | "script"
     | "noscript"
     | "template";
}[];

Defined in: studiocms/packages/@studiocms/blog/src/types.ts:5^

---

StudioCMSBlogOptions

type StudioCMSBlogOptions = {
  blog: {
     enableRSS: boolean;
     route: string;
     title: string;
  };
  favicon: string;
  htmlDefaultHead: {
     attrs: Record<string, string | boolean | undefined>;
     content: string;
     tag:   | "title"
        | "base"
        | "link"
        | "style"
        | "meta"
        | "script"
        | "noscript"
        | "template";
  }[];
  htmlDefaultLanguage: string;
  injectRoutes: boolean;
  sitemap: boolean;
};

Defined in: studiocms/packages/@studiocms/blog/src/types.ts:94^

Options for configuring the StudioCMS Blog.

Type Declaration

blog

blog: {
  enableRSS: boolean;
  route: string;
  title: string;
};

The configuration for the blog

blog.enableRSS

enableRSS: boolean;

Enable RSS feed

blog.route

route: string;

The route for the blog

Default

'/blog'

Example

'/news'

blog.title

title: string;

The title of the blog

favicon

favicon: string;

Favicon Configuration - The default favicon configuration for the Frontend

htmlDefaultHead

htmlDefaultHead: {
  attrs: Record<string, string | boolean | undefined>;
  content: string;
  tag:   | "title"
     | "base"
     | "link"
     | "style"
     | "meta"
     | "script"
     | "noscript"
     | "template";
}[];

HTML Default Header - The default head configuration for the Frontend

htmlDefaultLanguage

htmlDefaultLanguage: string;

HTML Default Language - The default language for the HTML tag

Default

'en'

injectRoutes

injectRoutes: boolean;

Inject routes

Default

true

sitemap

sitemap: boolean;

Enable sitemap generation

Default

true

Variables

faviconTypeMap

const faviconTypeMap: {
  .gif: string;
  .ico: string;
  .jpeg: string;
  .jpg: string;
  .png: string;
  .svg: string;
};

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

Type Declaration

.gif

.gif: string = 'image/gif';

.ico

.ico: string = 'image/x-icon';

.jpeg

.jpeg: string = 'image/jpeg';

.jpg

.jpg: string = 'image/jpeg';

.png

.png: string = 'image/png';

.svg

.svg: string = 'image/svg+xml';

---

FrontEndConfigSchema

const FrontEndConfigSchema: ZodDefault<StudioCMSBlogOptions>;

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

Options for configuring the StudioCMS Blog.

Functions

isFaviconExt()

function isFaviconExt(ext: string): ext is ".ico" | ".gif" | ".jpeg" | ".jpg" | ".png" | ".svg";

Defined in: studiocms/packages/@studiocms/blog/src/types.ts:17^

Parameters

ext

string

Returns

ext is “.ico” | “.gif” | “.jpeg” | “.jpg” | “.png” | “.svg”