An AuxiliaryStrategy that provides its functionality through the combination of an AuxiliaryIdentifierStrategy, MetadataGenerator and Validator.


  • ComposedAuxiliaryStrategy




identifierStrategy: AuxiliaryIdentifierStrategy
metadataGenerator?: MetadataGenerator
ownAuthorization: boolean
requiredInRoot: boolean
validator?: Validator


  • Adds metadata related to this auxiliary resource, in case this is required for this type of auxiliary resource. The metadata that is added depends on the given identifier being an auxiliary or subject resource: the metadata will be used to link to the other one, and potentially add extra typing info.

    Used for: Solid, ยง4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource."

    The above is an example of how that metadata would only be added in case the input is the subject identifier.


    Returns Promise<void>

  • Checks if the input identifier corresponds to an auxiliary resource. This does not check if that auxiliary resource exists, only if the identifier indicates that there could be an auxiliary resource there.


    true if the input identifier points to an auxiliary resource.


    Returns boolean

  • Whether the root storage container requires this auxiliary resource to be present. If yes, this means they can't be deleted individually from such a container.

    Returns boolean

  • Whether this auxiliary resources uses its own authorization instead of the subject resource authorization.

    Returns boolean

  • Validates if the representation contains valid data for an auxiliary resource. Should throw an error in case the data is invalid.


    • representation: Representation

      Representation of the auxiliary resource.

    Returns Promise<void>