@eagleoutice/flowr - v2.10.1
    Preparing search index...

    Interface FlowrCapabilityWithPath

    interface FlowrCapabilityWithPath {
        capabilities?: readonly FlowrCapability[];
        description?: string;
        example?: string | ((parser: KnownParser) => Promise<string>);
        id: string;
        name: string;
        needs?: RequiredFeature[];
        path: PathToCapability;
        supported?: "not" | "partially" | "fully";
        url?: { href: string; name: string }[];
    }

    Hierarchy (View Summary)

    Hierarchy-Diagram

    UML class diagram of FlowrCapabilityWithPath
    Index

    Properties

    capabilities? description? example? id name needs? path supported? url?

    Properties

    capabilities?: readonly FlowrCapability[]
    description?: string
    example?: string | ((parser: KnownParser) => Promise<string>)
    id: string

    The unique identifier of the capability, used to refer to it independent of the location. We could use a key-value mapping. However, this way, an id is self-contained and can be moved around as one object.

    name: string

    The human-readable name of the capability

    needs?: RequiredFeature[]

    A list of features that are required for the capability, extend at need.

    path: PathToCapability
    supported?: "not" | "partially" | "fully"

    The level of support for the capability, undefined if it is a meta-capability that does not need such an attribute

    url?: { href: string; name: string }[]

    A list of URLs that provide additional information about the capability

    Settings

    Member Visibility

    On This Page

    Properties