@apillon/sdk/dist/modules/storage/ipns.d.ts

▶◀ Apillon SDK for NodeJS ▶◀

import { ApillonModel } from '../../lib/apillon';
export declare class Ipns extends ApillonModel {
    /**
     * Informational IPNS name, which is set by user to easily organize their IPNS records.
     */
    name: string;
    /**
     * IPNS record description.
     */
    description: string;
    /**
     * IPNS name that is used to access IPNS content on IPFS gateway.
     */
    ipnsName: string;
    /**
     * IPFS value (CID), to which this IPNS points.
     */
    ipnsValue: string;
    /**
     * IPNS link to Apillon IPFS gateway, where it is possible to see content to which this IPNS points.
     */
    link: string;
    /**
     * Unique identifier of the IPNS record's bucket.
     */
    bucketUuid: string;
    /**
     * Constructor which should only be called via StorageBucket class.
     * @param bucketUuid Unique identifier of the file's bucket.
     * @param ipnsUuid Unique identifier of the IPNS record.
     * @param data Data to populate the IPNS record with.
     */
    constructor(bucketUuid: string, ipnsUuid: string, data?: Partial<Ipns>);
    /**
     * Publish an IPNS record to IPFS and link it to a CID.
     * @param {string} cid - CID to which this ipns name will point.
     * @returns IPNS record with updated data after publish
     */
    publish(cid: string): Promise<Ipns>;
    /**
     * Delete an IPNS record from the bucket.
     * @returns Deleted IPNS record
     */
    delete(): Promise<Ipns>;
}
//# sourceMappingURL=ipns.d.ts.map