setDescription
Set the description of the asset. This supports the markdown syntax.
Official OceanProtocol documentation: DDO Specification
Usage
import { AssetBuilder, Nautilus } from '@deltadao/nautilus'
import { Wallet } from 'ethers'
import Description from './description.md'
const nautilus = await Nautilus.create(new Wallet('0x1234'))
const assetBuilder = new AssetBuilder()
assetBuilder.setDescription(Description)
const asset = assetBuilder.build()
await nautilus.publish(asset)
// => ddo.metadata:
// => {
// => description: '# Asset Title\n\nA detailed description of my asset and what it offers.\n\nThis supports markdown, such as **highlights** or [links](https://link.to/my-external-resource) to other resources.'
// => }# Asset Title
A detailed description of my asset and what it offers.
This supports markdown, such as **highlights** or [links](https://link.to/my-external-resource) to other resources.Returns
- Type:
AssetBuilder
The asset builder instance to chain building calls with.
Parameter
description
- Type:
string
The description you want to set to the asset's metadata to be built. Can contain markdown syntax.
assetBuilder.setDescription(
'# Title for my asset\n\nA **detailed** description of my asset.'
)