@localnerve/sass-asset-functions 6.10.0-rc.1 → 6.10.0-rc.2

package/README.md

@@ -87,7 +87,8 @@ You can specify the paths to your resources using the following options (shown w
   images_path: 'public/images', // local directory
   fonts_path: 'public/fonts',
   http_images_path: '/images', // web path
-  http_fonts_path: '/fonts'
+  http_fonts_path: '/fonts',
+  data: {}
 }
 ```
 
@@ -120,39 +121,9 @@ const result = sass.compile(scss_filename, {
 });
 ```
 
-#### `asset_host`: a function which completes with a string used as asset host.
-
-```js
-const result = sass.compile(scss_filename, {
-  functions: assetFunctions({
-    asset_host: (http_path, done) => {
-      done('http://assets.example.com');
-      // or use the supplied path to calculate a host
-      done(`http://assets${http_path.length % 4}.example.com`);
-    }
-  })
-  [, options...]
-});
-```
-
-#### `asset_cache_buster`: a function to rewrite the asset path
-
-When this function returns a string, it's set as the query of the path. When returned an object, `path` and `query` will be used.
-
-```js
-const result = sass.compile(scss_filename, {
-  functions: assetFunctions({
-    asset_cache_buster: (http_path, real_path, done) => {
-      done('v=123');
-    }
-  })
-  [, options...]
-});
-```
-
-#### `lookup`: a function to use arbitrary data in scss stylesheets
+#### `lookup`: a function to use arbitrary data in sass stylesheets
 
-This function retrieves arbitrary build-time data for reference in stylesheet compilation. Could be an asset name, prefix, or could be a whole list or map of things. Here's the list of javascript types supported (everything returns SassNull):
+This function retrieves arbitrary build-time data for reference in stylesheet compilation. Could be an asset name, prefix, or could be a whole list or map of things. Here's the list of javascript type mappings (everything else returns SassNull):
   * Boolean => SassBoolean
   * Number => SassNumber
   * String => SassString
@@ -201,7 +172,37 @@ $nested-data: lookup('nested', 'process-map');
 }
 ```
 
-##### A more advanced example:
+#### `asset_host`: a function which completes with a string used as asset host.
+
+```js
+const result = sass.compile(scss_filename, {
+  functions: assetFunctions({
+    asset_host: (http_path, done) => {
+      done('http://assets.example.com');
+      // or use the supplied path to calculate a host
+      done(`http://assets${http_path.length % 4}.example.com`);
+    }
+  })
+  [, options...]
+});
+```
+
+#### `asset_cache_buster`: a function to rewrite the asset path
+
+When this function returns a string, it's set as the query of the path. When returned an object, `path` and `query` will be used.
+
+```js
+const result = sass.compile(scss_filename, {
+  functions: assetFunctions({
+    asset_cache_buster: (http_path, real_path, done) => {
+      done('v=123');
+    }
+  })
+  [, options...]
+});
+```
+
+##### A more advanced example of `asset_cache_buster`:
 
 Here we include the file's  hexdigest in the path, using the [`hexdigest`](https://github.com/koenpunt/node-hexdigest) module.
 

package/cjs/lib/modernAPIAsync.cjs

@@ -118,8 +118,8 @@ function modernAPIAsync(sass, processor) {
           let result = sass.sassNull;
           processor.lookup(keys, value => {
             result = (0, _types.convertToSassTypesModern)(sass, value);
+            resolve(result);
           });
-          resolve(result);
         } catch (err) {
           reject(err);
         }

package/cjs/lib/types.cjs

@@ -9,7 +9,7 @@ var _immutable = require("immutable");
 /**
  * Convert javascript types to sass types.
  * 
- * Supported:
+ * Supported Mappings:
  * Boolean => Sass.Boolean
  * Number => Sass.Number
  * String => Sass.String
@@ -28,6 +28,14 @@ var _immutable = require("immutable");
  * Licensed under the MIT license.
  */
 
+/**
+ * Convert a javascript value to a sass value of corresponding type.
+ * Modern Sass version.
+ * 
+ * @param {Sass} sass - Sass javascript API
+ * @param {*} value - A javascript value
+ * @returns {SassType} - A Sass typed value for the given javascript value
+ */
 function convertToSassTypesModern(sass, value) {
   switch (typeof value) {
     case 'boolean':
@@ -66,6 +74,15 @@ function convertToSassTypesModern(sass, value) {
       return sass.sassNull;
   }
 }
+
+/**
+ * Convert a javascript value to a sass value of corresponding type.
+ * Legacy Sass version.
+ * 
+ * @param {Sass} sass - Sass javascript API
+ * @param {*} value - A javascript value
+ * @returns {SassType} - A Sass typed value for the given javascript value
+ */
 function convertToSassTypesLegacy(sass, value) {
   switch (typeof value) {
     case 'boolean':

package/lib/modernAPIAsync.js

@@ -104,8 +104,8 @@ export default function modernAPIAsync (sass, processor) {
           let result = sass.sassNull;
           processor.lookup(keys, value => {
             result = convertToSassTypesModern(sass, value);
+            resolve(result);
           });
-          resolve(result);
         } catch (err) {
           reject(err);
         }

package/lib/types.js

@@ -1,7 +1,7 @@
 /**
  * Convert javascript types to sass types.
  * 
- * Supported:
+ * Supported Mappings:
  * Boolean => Sass.Boolean
  * Number => Sass.Number
  * String => Sass.String
@@ -21,6 +21,14 @@
  */
 import { OrderedMap } from 'immutable';
 
+/**
+ * Convert a javascript value to a sass value of corresponding type.
+ * Modern Sass version.
+ * 
+ * @param {Sass} sass - Sass javascript API
+ * @param {*} value - A javascript value
+ * @returns {SassType} - A Sass typed value for the given javascript value
+ */
 export function convertToSassTypesModern (sass, value) {
   switch (typeof value) {
     case 'boolean':
@@ -61,6 +69,14 @@ export function convertToSassTypesModern (sass, value) {
   }
 }
 
+/**
+ * Convert a javascript value to a sass value of corresponding type.
+ * Legacy Sass version.
+ * 
+ * @param {Sass} sass - Sass javascript API
+ * @param {*} value - A javascript value
+ * @returns {SassType} - A Sass typed value for the given javascript value
+ */
 export function convertToSassTypesLegacy (sass, value) {
   switch (typeof value) {
     case 'boolean':

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localnerve/sass-asset-functions",
-  "version": "6.10.0-rc.1",
+  "version": "6.10.0-rc.2",
   "description": "compass-style asset functions for dart-sass or other sass compilers",
   "main": "index.js",
   "exports": {