particle-api-js/src/Library.js

Particle API Client

/* Library
 * Represents a version of a library contributed in the cloud.
 */

class Library {
    constructor(client, data) {
        // Make client non-enumerable so it doesn't show up in Object.keys, JSON.stringify, etc
        Object.defineProperty(this, 'client', { value: client });
        this._assignAttributes(data);
        this.downloadUrl = data.links && data.links.download;
    }

    _assignAttributes(data) {
        Object.assign(this, data.attributes);
    }


    /**
     * Download the compressed file containing the source code for this library version.
     * @return {Promise} Resolves to the .tar.gz compressed source code
     */
    download() {
        if (!this.downloadUrl) {
            return Promise.reject(new Error('No download URL for this library'));
        }
        // @ts-ignore
        return this.client.downloadFile(this.downloadUrl);
    }

    /* TODO: add a versions() method to fetch an array of library objects */
}

module.exports = Library;