Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/condorheroblog/import-from-string
Load module from string using require or import
https://github.com/condorheroblog/import-from-string
bundler-config import-from-string load-config load-module load-module-from-string module-from-string require-from-string
Last synced: 3 months ago
JSON representation
Load module from string using require or import
- Host: GitHub
- URL: https://github.com/condorheroblog/import-from-string
- Owner: condorheroblog
- License: mit
- Created: 2023-11-04T06:48:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-06T13:48:46.000Z (3 months ago)
- Last Synced: 2024-11-06T14:41:22.991Z (3 months ago)
- Topics: bundler-config, import-from-string, load-config, load-module, load-module-from-string, module-from-string, require-from-string
- Language: TypeScript
- Homepage: https://stackblitz.com/edit/import-from-string-demo?file=index.mjs
- Size: 96.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Import-from-string
[](https://www.npmjs.com/package/import-from-string)
[](https://www.npmjs.com/package/import-from-string)
[](https://github.com/condorheroblog/import-from-string/blob/main/LICENSE)
[](https://github.com/condorheroblog/import-from-string/blob/main/packages/import-from-string)
Load module from string using require or import.
## Features
- Support ESM and CJS environments
- Support dynamic import
- Support `import.meta.url`
- Support access to global variables
- No asynchronous IO operations
- No module cache
## Install
```bash
npm install import-from-string
```
## Usage
### ESM
```mjs
import { importFromString, requireFromString } from "import-from-string";
const cjs = requireFromString("module.exports = 'Hi World!'");
console.log(cjs); // Hi World!
const esm = await importFromString("export default 'Hello World!'");
console.log(esm.default); // Hello World!
```
### CJS
```cjs
const { requireFromString, importFromString } = require("import-from-string");
async function main() {
const cjs = requireFromString("module.exports = 'Hi World!'");
console.log(cjs); // Hi World!
const esm = await importFromString("export default 'Hello World!'");
console.log(esm.default); // Hello World!
}
main();
```
## API
### importFromString(code, options?)
#### code
Type: `string`
The code to import.
#### options
##### filename
Type: `string`\
Default: `{Date.now()}.js`
The virtual file name of the code to import.
##### dirname
Type: `string`\
Default: `The directory where the function is called`
The virtual directory to import the code into.
##### transformOptions
Type: `TransformOptions`
esbuild transform options.
##### esbuildOptions
Type: `BuildOptions`
esbuild options.
##### skipBuild
Type: `boolean`\
Default: `false`
skip esbuild build.
### requireFromString(code, options?)
#### code
Type: `string`
The code to import.
#### options
##### filename
Type: `string`\
Default: `{Date.now()}.js`
The virtual file name of the code to import.
##### dirname
Type: `string`\
Default: `The directory where the function is called`
The virtual directory to import the code into.
##### appendPaths
Type: `string[]`\
Default: `[]`
An array of additional paths to append when resolving modules.
##### prependPaths
Type: `string[]`\
Default: `[]`
An array of additional paths to prepend when resolving modules.
## Appreciation
- [bundle-require](https://github.com/egoist/bundle-require)
- [module-from-string](https://github.com/exuanbo/module-from-string)
- [require-from-string](https://github.com/floatdrop/require-from-string)
## License
[MIT](https://github.com/condorheroblog/import-from-string/blob/main/LICENSE) License © 2023-Present [Condor Hero](https://github.com/condorheroblog)