npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

device-asset

v1.0.0

Published

Easily get device-specific assets.

Downloads

2

Readme

device-asset

Motivation

device-asset is used to read the browser's window + screen to calculate the best file size you should use for a given asset. Additionally, you can pass options like base and ext to immediately create the correct filename path.

Specific Devices supported:

  • iphone 4
  • iphone 5
  • iphone 6
  • iphone 6 plus
  • ipad
  • ipad air
  • ipad retina
  • ipad pro
  • samsung galaxy
  • surface 3
  • android
  • android hd

Node.js Usage

Use anywhere you have a global window and screen object. Filenames will become back as a string that corresponds to the keys in config.json.


var da = require('device-asset');

da.getAsset();

will produce a response:

{
  "displayName": "iPhone 6 Plus",
  "fileName": "iphone_6_plus",
  "res": {
    "w": 1242,
    "h": 2208
  }
}

Additionally, you can pass options base or ext like so:


var da = require('device-asset');
da.getAsset({
  base: 'http://mysite.com/images/',
  ext: 'jpg'
});

will produce a response with useful fileName:

{
  "displayName": "iPhone 6 Plus",
  "fileName": "http://mysite.com/images/iphone_6_plus.jpg",
  "res": {
    "w": 1242,
    "h": 2208
  }
}

If you're feeling extra lucky, you can pass your own config (use the structure in config.json).


var da = require('device-asset');
var customConfig = {
  "custom_thing": {
    "displayName": "Custom Thing",
    "fileName": "custom_thing",
    "res": {
      "w": 600,
      "h": 800
    }
  },
  "custom_thing_2": {
    "displayName": "Custom Thing 2",
    "fileName": "custom_thing 2",
    "res": {
      "w": 200,
      "h": 300
    }
  }
}
da.getAsset({
  base: 'http://mysite.com/images/',
  ext: 'jpg'
}, customConfig);

You can also get the default config by using getDevices.


var da = require('device-asset');

function getOptions(devices) {
  return Object.keys(devices).map(function(d) {
   var elm = document.createElement('option');
   elm.value = devices[k].fileName; 
   elm.innerHTML = devices[k].displayName

   return elm;
  });
}

var devices = getOptions(da.getDevices());

Non-npm Usage

To use outside of NPM, require the device-asset-min.js file in your project which will expose a global deviceAsset object.

<html>
<head>
<title>Page</title>
</head>
<body>
  <div id="mount"></div>
  <script type="text/javascript" src="/device-asset-min.js"></script>
  <script>
    var bestAsset = deviceAsset.getAsset({
      base: 'http://mysite.com/images/',
      ext: 'jpg'
    });

    var image = document.createElement('img');
    image.src = bestAsset.fileName;

    var container = document.getElementById('mount');
    container.appendChild(image);
  </script>
</body>
</html>