1
0
mirror of https://github.com/oceanprotocol-archive/squid-js.git synced 2024-02-02 15:31:51 +01:00

added function docs

This commit is contained in:
alexcos20 2020-03-31 12:01:00 +03:00
parent 091df0f9d4
commit 06e5e6bf6c

View File

@ -261,6 +261,14 @@ export class Aquarius {
return result return result
} }
/**
* Edit Metadata for a DDO.
* @param {did} string DID.
* @param {newMetadata} EditableMetaData Metadata fields & new values.
* @param {String} updated Updated field of the DDO
* @param {String} signature Signature using updated field to verify that the consumer has rights
* @return {Promise<String>} Result.
*/
public async editMetadata( public async editMetadata(
did: DID | string, did: DID | string,
newMetadata: EditableMetaData, newMetadata: EditableMetaData,
@ -299,6 +307,13 @@ export class Aquarius {
return result return result
} }
/**
* Retire a DDO (Delete)
* @param {DID | string} did DID of the asset to update.
* @param {String} updated Updated field of the DDO
* @param {String} signature Signature using updated field to verify that the consumer has rights
* @return {Promise<String>} Result.
*/
public async retire( public async retire(
did: DID | string, did: DID | string,
updated: string, updated: string,