javascript/node/externs/jszip.js

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

/**
 * @fileoverview Extern definitions for the `jszip` npm package:
 * <https://www.npmjs.com/package/jszip>
 */

/** @interface */
var Entry = function() {};

/**
 * @param {string} type
 * @return {!Promise<!Buffer>}
 */
Entry.prototype.async;


/** @constructor */
var Archive = function() {};

/**
 * @param {string} path
 * @param {Buffer=} data
 * @return {?Entry}
 */
Archive.prototype.file;

/**
 * @param {string} path
 * @return {!Archive}
 */
Archive.prototype.folder;

/**
 * @param {function(string, !Entry): void} callback
 */
Archive.prototype.forEach;

/**
 * @param {{compression: string, type: string}} options
 * @return {!Promise<!Buffer>}
 */
Archive.prototype.generateAsync;

/**
 * @param {!Buffer} data
 * @return {!Promise<!Archive>}
 */
Archive.prototype.loadAsync;


module.exports = Archive;