Type alias SingleServiceDependency

SingleServiceDependency: {
    current?: string;
    description?: string;
    multiple: false;
    name: string;
    required: boolean;
    title: string;
    version: string;
}

Object describing a single-service dependency defined by a Foxx service.

Type declaration

  • Optional current?: string

    Current mount point the dependency is resolved to.

  • Optional description?: string

    Human-readable description of the dependency.

  • multiple: false

    Whether this is a multi-service dependency.

  • name: string

    Name of the service the dependency expects to match.

  • required: boolean

    Whether the dependency must be matched in order for the service to be operational.

  • title: string

    Formatted name of the dependency.

  • version: string

    Version of the service the dependency expects to match.