Interface AssetArtifactAdapter<CategoryKind, AddressKind>

interface AssetArtifactAdapter<
    CategoryKind extends AssetArtifactCategory = AssetArtifactCategory,
    AddressKind extends
        AssetArtifactAddressFragment = AssetArtifactAddressFragment,
> {
    compareCandidates(
        a: ArtifactCandidate<CategoryKind, AddressKind>,
        b: ArtifactCandidate<CategoryKind, AddressKind>,
    ): number;
    getArtifactCategory(artifact: AssetArtifactFragment): null | CategoryKind;
    getArtifactFromCandidate(
        candidate: ArtifactCandidate<CategoryKind, AddressKind>,
    ): null | AssetArtifact;
    isCandidateAddress(
        fragment: AssetArtifactAddressFragment,
    ): fragment is AddressKind;
}

Type Parameters

CategoryKind extends AssetArtifactCategory = AssetArtifactCategory
AddressKind extends AssetArtifactAddressFragment = AssetArtifactAddressFragment

Implemented by

Index

Methods

compareCandidates? getArtifactCategory getArtifactFromCandidate isCandidateAddress

Methods

`Optional`compareCandidates

compareCandidates(
a: ArtifactCandidate<CategoryKind, AddressKind>,
b: ArtifactCandidate<CategoryKind, AddressKind>,
): number
Comparison function for two candidates. Is used by the ArtifactMapper when there are multiple candidates, if implemented, otherwise ArtifactMapper.compareCandidatesByDate is used.
Parameters
- a: ArtifactCandidate<CategoryKind, AddressKind>
- b: ArtifactCandidate<CategoryKind, AddressKind>
Returns number
- Defined in packages/sdk/asset/core/src/lib/api/mapper/artifacts/ArtifactMapper.ts:39

getArtifactCategory

getArtifactCategory(artifact: AssetArtifactFragment): null | CategoryKind
For a given AssetArtifactFragment, checks whether the expected category can be extracted from it. If not, null is returned, meaning that this artifact is not a candidate.
Parameters
- artifact: AssetArtifactFragment
Returns null | CategoryKind
- Defined in packages/sdk/asset/core/src/lib/api/mapper/artifacts/ArtifactMapper.ts:23

getArtifactFromCandidate

getArtifactFromCandidate(
candidate: ArtifactCandidate<CategoryKind, AddressKind>,
): null | AssetArtifact
Maps the given ArtifactCandidate to an AssetArtifact.
Parameters
- candidate: ArtifactCandidate<CategoryKind, AddressKind>
Returns null | AssetArtifact
- Defined in packages/sdk/asset/core/src/lib/api/mapper/artifacts/ArtifactMapper.ts:33

isCandidateAddress

isCandidateAddress(
fragment: AssetArtifactAddressFragment,
): fragment is AddressKind
Checks whether the given address is suited for an artifact candidate.
Parameters
- fragment: AssetArtifactAddressFragment
Returns fragment is AddressKind
- Defined in packages/sdk/asset/core/src/lib/api/mapper/artifacts/ArtifactMapper.ts:28