index

Functions

'Read the “', Functions, '” section'

studioCMSDevApps()

'Read the “', studioCMSDevApps(), '” section'

function studioCMSDevApps(opts?: {
  appsConfig: {
     libSQLViewer: boolean;
     wpImporter:   | boolean
        | {
        endpoint: string;
       };
    };
  endpoint: string;
  verbose: boolean;
 }): AstroIntegration

Defined in: studiocms/packages/studiocms_devapps/src/index.ts:43

Integrates StudioCMS development applications with Astro.

Parameters

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

opts?

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

Optional configuration options for StudioCMS DevApps.

appsConfig?

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

{ libSQLViewer: boolean; wpImporter: | boolean | { endpoint: string; }; } = AppsConfigSchema

appsConfig.libSQLViewer?

'Read the “', appsConfig.libSQLViewer?, '” section'

boolean = ...

Astro DB LibSQL Viewer App Config

appsConfig.wpImporter

'Read the “', appsConfig.wpImporter, '” section'

| boolean | { endpoint: string; } = ...

StudioCMS WP API Importer App Config

endpoint?

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

string = ...

verbose?

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

boolean = ...

Returns

'Read the “', Returns, '” section'

AstroIntegration

The Astro integration object for StudioCMS DevApps.

Remarks

'Read the “', Remarks, '” section'

This function sets up the StudioCMS development applications for use in an Astro project. It parses the provided options, sets up virtual imports, and adds development toolbar apps based on the configuration.

The integration is enforced to run only in development mode.

Example

'Read the “', Example, '” section'

import { studioCMSDevApps } from '@studiocms/devapps';

export default {
  integrations: [
    studioCMSDevApps({
      endpoint: '/api',
      appsConfig: {
        wpImporter: {
          enabled: true,
          endpoint: '/wp-import',
        },
        libSQLViewer: {
          enabled: true,
        },
      },
      verbose: true,
    }),
  ],
};

References

'Read the “', References, '” section'

default

'Read the “', default, '” section'

Renames and re-exports studioCMSDevApps