Type alias ServiceSummary

ServiceSummary: {
    development: boolean;
    legacy: boolean;
    mount: string;
    name?: string;
    provides: Record<string, string>;
    version?: string;
}

Object briefly describing a Foxx service.

Type declaration

  • development: boolean

    Whether development mode is enabled for this service.

  • legacy: boolean

    Whether the service is running in legacy compatibility mode.

  • mount: string

    Service mount point, relative to the database.

  • Optional name?: string

    Name defined in the service manifest.

  • provides: Record<string, string>

    Service dependencies the service expects to be able to match as a mapping from dependency names to versions the service is compatible with.

  • Optional version?: string

    Version defined in the service manifest.

Settings

Theme