dag-node / Exports / MediaReference
Class: MediaReference
Immutable value object representing a media asset reference. Normalizes asset ID and URI references into a canonical form.
Table of contents
Methods
- fromAssetReference
- fromBinary
- fromCandidate
- isAsset
- isUri
- assetId
- uri
- mediaType
- toAssetIdOrUri
- toAssetContentUrl
- toBinary
Methods
fromAssetReference
▸ fromAssetReference(reference): MediaReference
Parameters
| Name | Type |
|---|---|
reference | TAssetReference |
Returns
Defined in
packages/dag-node/src/value-objects/media-reference.ts:35
fromBinary
▸ fromBinary(value): TResult<MediaReference, IDagError>
Parameters
| Name | Type |
|---|---|
value | IPortBinaryValue |
Returns
TResult<MediaReference, IDagError>
Defined in
packages/dag-node/src/value-objects/media-reference.ts:54
fromCandidate
▸ fromCandidate(candidate, options?): TResult<MediaReference, IDagError>
Parameters
| Name | Type |
|---|---|
candidate | IMediaReferenceCandidate |
options? | Object |
options.allowEmptyUri? | boolean |
options.allowEmptyAssetId? | boolean |
Returns
TResult<MediaReference, IDagError>
Defined in
packages/dag-node/src/value-objects/media-reference.ts:98
isAsset
▸ isAsset(): boolean
Returns
boolean
Defined in
packages/dag-node/src/value-objects/media-reference.ts:145
isUri
▸ isUri(): boolean
Returns
boolean
Defined in
packages/dag-node/src/value-objects/media-reference.ts:149
assetId
▸ assetId(): undefined | string
Returns
undefined | string
Defined in
packages/dag-node/src/value-objects/media-reference.ts:153
uri
▸ uri(): undefined | string
Returns
undefined | string
Defined in
packages/dag-node/src/value-objects/media-reference.ts:157
mediaType
▸ mediaType(): undefined | string
Returns
undefined | string
Defined in
packages/dag-node/src/value-objects/media-reference.ts:161
toAssetIdOrUri
▸ toAssetIdOrUri(): { referenceType: "asset" ; assetId: string } | { referenceType: "uri" ; uri: string }
Returns
{ referenceType: "asset" ; assetId: string } | { referenceType: "uri" ; uri: string }
Defined in
packages/dag-node/src/value-objects/media-reference.ts:165
toAssetContentUrl
▸ toAssetContentUrl(baseUrl): undefined | string
Parameters
| Name | Type |
|---|---|
baseUrl | string |
Returns
undefined | string
Defined in
packages/dag-node/src/value-objects/media-reference.ts:180
toBinary
▸ toBinary(kind, defaultMimeType): IPortBinaryValue
Parameters
| Name | Type |
|---|---|
kind | TBinaryKind |
defaultMimeType | string |
Returns
IPortBinaryValue