Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

gif-me-info

1.0.2 • Public • Published

gif-me-info

Promise-based gif information and stats.

Install

npm i gif-me-info

Notes

Provides promised results for gify-parse allowing users to get information for a single gif url or an array of gif urls.

Authors

Table of Contents

  1. How to Use
  2. Usage
  3. Info Properties
  4. Requirements
  5. Contributing
  6. Acknowledgments

Usage

npm i gif-me-info

How to Use

// Require or import the package (name it anything you'd like) wherever you'd like to use it:
const gifInfo = require('gif-me-info');
 
// Function takes in a single url or array of gif urls
let gifUrls = [
  'http://media2.giphy.com/media/FiGiRei2ICzzG/200.gif',
  'http://media0.giphy.com/media/feqkVgjJpYtjy/200.gif'
];
 
// Use an async function to await the results
const asyncExample = async () => {
  let result = await gifInfo(gifUrls);
  console.log(result);
}
 
 
// Or use .then promise chain to access results 
const promiseExample = () => {
  gifInfo(gifUrls)
  .then(results => console.log(results))
};
 
/* Sample results: (Data format: Array of objects)
[
    {
        "valid": true,
        "globalPalette": true,
        "globalPaletteSize": 256,
        "globalPaletteColorsRGB": [
            {
                "r": 217,
                "g": 217,
                "b": 217
            }, ...more
        ],
        "loopCount": 0,
        "height": 832,
        "width": 1264,
        "animated": true,
        "images": [
            {
                "identifier": "0",
                "localPalette": false,
                "localPaletteSize": 0,
                "interlace": false,
                "comments": [],
                "text": "",
                "left": 0,
                "top": 0,
                "width": 1264,
                "height": 832,
                "delay": 30,
                "disposal": 1
            },
            {
                "identifier": "1",
                "localPalette": false,
                "localPaletteSize": 0,
                "interlace": false,
                "comments": [],
                "text": "",
                "left": 0,
                "top": 0,
                "width": 1,
                "height": 1,
                "delay": 30,
                "disposal": 1
            },
            {
                "identifier": "2",
                "localPalette": false,
                "localPaletteSize": 0,
                "interlace": false,
                "comments": [],
                "text": "",
                "left": 0,
                "top": 0,
                "width": 1,
                "height": 1,
                "delay": 30,
                "disposal": 1
            },
            ...more
        ],
        "isBrowserDuration": true,
        "duration": 7230,
        "durationIE": 24100,
        "durationSafari": 7230,
        "durationFirefox": 7230,
        "durationChrome": 7230,
        "durationOpera": 7230,
        "url": "http://devcenter.wintellect.com/wp-content/uploads/2016/10/Spectron.gif"
    }
*/
 

Info Properties

All of the properties provided by gify-parse module.

Requirements

  • Node 7.6

Contributing

This is just an encapsulation of the gify-parse package (which does the bulk of the work) created for another project, but if you would like to contribute please make a pull request with your work. Feel free to contact me and introduce yourself as well.

Acknowledgments

install

npm i gif-me-info

Downloadsweekly downloads

2

version

1.0.2

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability