insomnia-node-libcurl/lib/CurlFileInfo.js

Node bindings for libcurl. Based on the work from node-curl.

/**
 * @file
 * @author Jonathan Cardoso Machado
 * @license MIT
 * @copyright 2016, Jonathan Cardoso Machado
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/**
 * CurlFileInfo data type, the first parameter
 * passed to the callback set using the option ``CHUNK_BGN_FUNCTION``.
 *
 * @typedef CurlFileInfo
 * @memberof module:node-libcurl
 * @inner
 * @readonly
 *
 * @type Object
 * @property {String} fileName
 * @property {Number} fileType Value to be used with {@link module:node-libcurl.Curl.filetype}
 * @property {Date} time
 * @property {Number} perm
 * @property {Number} uid
 * @property {Number} gid
 * @property {Number} size
 * @property {Number} hardLinks
 * @property {Object} strings
 * @property {String} strings.time
 * @property {String} strings.perm
 * @property {String} strings.user
 * @property {String} strings.group
 * @property {String|Null} strings.target
 */