aboutsummaryrefslogtreecommitdiff
path: root/node_modules/require-from-string/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/require-from-string/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/require-from-string/readme.md')
-rw-r--r--node_modules/require-from-string/readme.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/node_modules/require-from-string/readme.md b/node_modules/require-from-string/readme.md
new file mode 100644
index 00000000..88b3236f
--- /dev/null
+++ b/node_modules/require-from-string/readme.md
@@ -0,0 +1,56 @@
+# require-from-string [![Build Status](https://travis-ci.org/floatdrop/require-from-string.svg?branch=master)](https://travis-ci.org/floatdrop/require-from-string)
+
+Load module from string in Node.
+
+## Install
+
+```
+$ npm install --save require-from-string
+```
+
+
+## Usage
+
+```js
+var requireFromString = require('require-from-string');
+
+requireFromString('module.exports = 1');
+//=> 1
+```
+
+
+## API
+
+### requireFromString(code, [filename], [options])
+
+#### code
+
+*Required*
+Type: `string`
+
+Module code.
+
+#### filename
+Type: `string`
+Default: `''`
+
+Optional filename.
+
+
+#### options
+Type: `object`
+
+##### appendPaths
+Type: `Array`
+
+List of `paths`, that will be appended to module `paths`. Useful, when you want
+to be able require modules from these paths.
+
+##### prependPaths
+Type: `Array`
+
+Same as `appendPaths`, but paths will be prepended.
+
+## License
+
+MIT © [Vsevolod Strukchinsky](http://github.com/floatdrop)