removeRecord

removeRecord is a method on the ANT class that removes a record from the ANT process.

removeRecord requires authentication.

Parameters

ParameterTypeDescriptionOptional
undernameStringUndername to remove record for. `@` represents the top level name.false
tagsarrayAn array of GQL tag objects to attach to the transfer AO message.true

Examples

removeRecord

 const fs = require("fs");
 const { ANT, ArweaveSigner } = require("@ar.io/sdk");

 async function main() {
 const jwk = JSON.parse(fs.readFileSync("KeyFile.json"));
 const ant = ANT.init({
     signer: new ArweaveSigner(jwk),
     processId: "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM"
 });

 const { id: txId } = await ant.removeRecord(
         {
             undername: 'remove-domain',
         },
         // optional additional tags
         { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
     );
 }

 main();