resolve-options

WebJar for resolve-options

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

resolve-options
Last Version

Last Version

1.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

resolve-options
WebJar for resolve-options
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/gulpjs/resolve-options

Download resolve-options

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/resolve-options/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>resolve-options</artifactId>
    <version>1.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/resolve-options/
implementation 'org.webjars.npm:resolve-options:1.1.0'
// https://jarcasting.com/artifacts/org.webjars.npm/resolve-options/
implementation ("org.webjars.npm:resolve-options:1.1.0")
'org.webjars.npm:resolve-options:jar:1.1.0'
<dependency org="org.webjars.npm" name="resolve-options" rev="1.1.0">
  <artifact name="resolve-options" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='resolve-options', version='1.1.0')
)
libraryDependencies += "org.webjars.npm" % "resolve-options" % "1.1.0"
[org.webjars.npm/resolve-options "1.1.0"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : value-or-function jar [3.0.0,4)

Project Modules

There are no modules declared in this project.

resolve-options

NPM version Downloads Build Status AppVeyor Build Status Coveralls Status Gitter chat

Resolve an options object based on configuration.

Usage

// This example assumes a Vinyl file

var createResolver = require('resolve-options');

var config = {
  cwd: {
    type: 'string',
    default: process.cwd
  },
  sourcemaps: {
    type: 'boolean',
    default: false
  },
  since: {
    type: ['date', 'number']
  },
  read: {
    type: 'boolean'
  }
};

var options = {
  sourcemaps: true,
  since: Date.now(),
  read: function(file) {
    return (file.extname !== '.mp4');
  }
};

var resolver = createResolver(config, options);

var cwd = resolver.resolve('cwd', file);
// cwd === process.cwd()

var sourcemaps = resolver.resolve('sourcemaps', file);
// sourcemaps === true

var read = resolver.resolve('read', file);
// Given .mp4, read === false
// Given .txt, read === true

API

createResolver([config,] [options])

Takes a config object that describes the options to accept/resolve and an options object (usually passed by a user) to resolve against the config. Returns a resolver that contains a resolve method for realtime resolution of options.

The config object takes the following structure:

config {
  [optionKey] {
    type // string, array or function
    default // any value or function
  }
}

Each option is represented by its optionKey in the config object. It must be an object with a type property.

The type property must be a string, array or function which will be passed to the value-or-function module (functions will be bound to the resolver to allow for dependent options).

A default property may also be specified as a fallback if the option isn't available or is invalid. The default value can be any value or a function (functions will be bound to the resolver to allow for dependent defaults). Note: default values are not type-validated by the value-or-function module.

resolver.resolve(optionKey, [...arguments])

Takes an optionKey string and any number of arguments to apply if an option is a function. Returns the resolved value for the optionKey.

License

MIT

org.webjars.npm

gulp

A toolkit to automate & enhance your workflow

Versions

Version
1.1.0