JSPM

  • Created
  • Published
  • Downloads 32876
  • Score
    100M100P100Q145793F
  • License MIT

Find an asset in a set of locations

Package Exports

  • asset-resolver

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (asset-resolver) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

asset-resolver Build Status Coverage Status

Helper module to find an asset in a set of locations

Install

$ npm install --save asset-resolver

Usage

var resolver = require('asset-resolver');

resolver.getResource('my.svg',{
    base: ['some/directory','http://some.domain/assets']
}).then(function(resource) {
    console.log(resource)
});
//=> { path: http://some.domain/assets/my.svg', mime: 'image/svg+xml', contents: ' ... ' }

API

resolver(input, [options])

input

Type: string

The filename

options

base

Type: string,array Default: [process.cwd()] Required: false Example: ['http://domain.de/', 'http://domain.de/styles', 'app/images', '**/images/']

List of directories/urls where we should start looking for assets (supports globbing on directories).

filter

Type: function Default: function(){ return true; } Required: false Example:

resolver.getResource('my.svg',{
    base: ['some/directory','http://some.domain/assets'],
    filter: function (resource) {
        return filesize(resource) < maxFileSize;
    }
}).then(function(resource) {
    console.log(resource)
});

List of directories/urls where we should start looking for assets.

CLI

$ npm install --global asset-resolver
$ asset-resolver --help

  Usage
    asset-resolver [input]

  Options
    -b --base  List of directories/urls where we should start looking for assets. [Default: process.cwd()]

  Examples
    $ asset-resolver 'my.svg' -b 'some/directory' -b 'http://some.domain/assets'
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <svg>
    ...
    </svg>

License

MIT © Ben Zörb