• Preparing search index...
  • The search index is not available
@dataspecer/genapp
  • @dataspecer/genapp
  • capabilities
  • getCapabilityMetadata

Function getCapabilityMetadata

  • getCapabilityMetadata(
        targetIri: CapabilityIdentifier,
        humanLabel: undefined | string,
    ):
        | DetailCapabilityMetadata
        | CreateInstanceCapabilityMetadata
        | DeleteInstanceCapabilityMetadata
        | EditInstanceCapabilityMetadata
        | ListCapabilityMetadata
  • Retrieves a capability metadata object from the provided capability identifier.

    Parameters

    • targetIri: CapabilityIdentifier

      The identifier of the capability to get metadata for. Must be one of the predefined capability identifiers.

    • humanLabel: undefined | string

    Returns
        | DetailCapabilityMetadata
        | CreateInstanceCapabilityMetadata
        | DeleteInstanceCapabilityMetadata
        | EditInstanceCapabilityMetadata
        | ListCapabilityMetadata

    A specific capability metadata instance corresponding to the provided identifier.

    Throws

    If an invalid target identifier is provided.

    • Defined in capabilities/index.ts:48

Settings

Member Visibility
@dataspecer/genapp
  • Loading...

Generated using TypeDoc