Type alias ServiceInfo

ServiceInfo: {
    checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}

Object describing a Foxx service in detail.

Type declaration

  • checksum: string

    Internal checksum of the service's initial source bundle.

  • development: boolean

    Whether development mode is enabled for this service.

  • legacy: boolean

    Whether the service is running in legacy compatibility mode.

  • manifest: FoxxManifest

    Content of the service manifest of this service.

  • mount: string

    Service mount point, relative to the database.

  • Optional name?: string

    Name defined in the service manifest.

  • options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    }

    Options for this service.

    • configuration: Record<string, any>

      Configuration values set for this service.

    • dependencies: Record<string, string>

      Service dependency configuration of this service.

  • path: string

    File system path of the service.

  • Optional version?: string

    Version defined in the service manifest.

Generated using TypeDoc