summaryrefslogtreecommitdiffstats
path: root/node_modules/loader-runner/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/loader-runner/README.md')
-rw-r--r--node_modules/loader-runner/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/node_modules/loader-runner/README.md b/node_modules/loader-runner/README.md
new file mode 100644
index 0000000..8cc04cb
--- /dev/null
+++ b/node_modules/loader-runner/README.md
@@ -0,0 +1,42 @@
+# loader-runner
+
+``` js
+import { runLoaders } from "loader-runner";
+
+runLoaders({
+ resource: "/abs/path/to/file.txt?query",
+ // String: Absolute path to the resource (optionally including query string)
+
+ loaders: ["/abs/path/to/loader.js?query"],
+ // String[]: Absolute paths to the loaders (optionally including query string)
+ // {loader, options}[]: Absolute paths to the loaders with options object
+
+ context: { minimize: true },
+ // Additional loader context which is used as base context
+
+ readResource: fs.readFile.bind(fs)
+ // A function to read the resource
+ // Must have signature function(path, function(err, buffer))
+
+}, function(err, result) {
+ // err: Error?
+
+ // result.result: Buffer | String
+ // The result
+
+ // result.resourceBuffer: Buffer
+ // The raw resource as Buffer (useful for SourceMaps)
+
+ // result.cacheable: Bool
+ // Is the result cacheable or do it require reexecution?
+
+ // result.fileDependencies: String[]
+ // An array of paths (files) on which the result depends on
+
+ // result.contextDependencies: String[]
+ // An array of paths (directories) on which the result depends on
+})
+```
+
+More documentation following...
+