Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuxiliaryIdentifierStrategy

A strategy for handling auxiliary related ResourceIdentifiers.

Hierarchy

  • AuxiliaryIdentifierStrategy

Index

Properties

Properties

getAssociatedIdentifier

getAssociatedIdentifier: (identifier: ResourceIdentifier) => ResourceIdentifier

Returns the identifier of the resource which this auxiliary resource is referring to. This does not guarantee that this resource exists.

param

Identifier of the auxiliary resource.

returns

The ResourceIdentifier of the corresponding resource.

Type declaration

getAuxiliaryIdentifier

getAuxiliaryIdentifier: (identifier: ResourceIdentifier) => ResourceIdentifier

Returns the identifier of the auxiliary resource corresponding to the given resource. This does not guarantee that this auxiliary resource exists.

Should error if there are multiple results: see getAuxiliaryIdentifiers.

param

The ResourceIdentifier of which we need the corresponding auxiliary resource.

returns

The ResourceIdentifier of the corresponding auxiliary resource.

Type declaration

getAuxiliaryIdentifiers

getAuxiliaryIdentifiers: (identifier: ResourceIdentifier) => ResourceIdentifier[]

Returns all the identifiers of corresponding auxiliary resources. This can be used when there are potentially multiple results. In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.

param

The ResourceIdentifier of which we need the corresponding auxiliary resources.

returns

The ResourceIdentifiers of the corresponding auxiliary resources.

Type declaration

isAuxiliaryIdentifier

isAuxiliaryIdentifier: (identifier: ResourceIdentifier) => boolean

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.

param

Identifier to check.

returns

true if the input identifier points to an auxiliary resource.

Type declaration