aia-kit/dist/asset.d.ts

Read, Parse, Edit, Write, Analyze AIA/AIX/AIS files.

/**
 * Class that describes an asset file.
 *
 * @since  1.0.0
 * @access public
 */
export declare class Asset {
    /**
     * Name of this asset, as defined by the user in their project.
     * @since  1.0.0
     */
    name: string;
    /**
     * File type of this asset.
     * @since  1.0.0
     */
    type: string;
    /**
     * Blob representing this project. This is undefined in .aiv files as Blob
     * functions are not stringified into JSON.
     * @since  1.0.0
     */
    private readonly blob;
    /**
     * Size of this asset in bytes.
     * @since  1.0.0
     */
    size: number;
    /**
     * Temporary URL representing this blob
     * @since  1.0.0
     * @type   {String}
     */
    private url;
    /**
     * Creates a new AIAsset object.
     *
     * @since 1.0.0
     * @access public
     *
     * @class
     * @param {String} name The name of this asset file.
     * @param {String} type The asset's file type (png, jpg, etc.)
     * @param {Blob} blob   The blob representing this asset's contents.
     *
     * @return {Asset} New AIAsset object.
     */
    constructor(name: string, type: string, blob: Blob);
    /**
     * Returns a unique URL that can be used to display this asset to the user.
     *
     * @since 1.0.0
     * @access public
     *
     * @return {String} Temporary URL pointing to this asset's blob.
     */
    getURL(): string;
    /**
     * Revokes any URL set to point to this asset's blob.
     *
     * @since 1.0.0
     * @access public
     */
    revokeURL(): void;
}