https://github.com/ozum/import-glocal
Import a globally installed module if your module is installed globally and no local module is found.
https://github.com/ozum/import-glocal
Last synced: about 2 months ago
JSON representation
Import a globally installed module if your module is installed globally and no local module is found.
- Host: GitHub
- URL: https://github.com/ozum/import-glocal
- Owner: ozum
- License: mit
- Created: 2021-02-13T10:29:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-13T13:18:56.000Z (over 4 years ago)
- Last Synced: 2025-03-10T17:07:22.725Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 290 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# import-glocal
Import a globally installed module if your module is installed globally and no local module is found.
- [Installation](#installation)
- [Synopsis](#synopsis)
- [Details](#details)
- [API](#api)
- [import-glocal](#import-glocal)
- [Table of contents](#table-of-contents)
- [Functions](#functions)
- [Functions](#functions-1)
- [default](#default)
# Installation
# Synopsis
```ts
import importModule from "import-glocal";
// Try to import "my-plugin" or "awesome-my-plugin" from local or global (if parent model is global or linked) modules.
const imported = await importModule("my-plugin", { prefix: "awesome-" });
const importedTypeScript = await importModule string>("my-plugin");
```
# Details
`import-glocal` asynchronously imports a module from local or global modules installed by `npm` or `yarn`. Local modules are preferred.
Global modules are imported only if your module is also installed globally or linked by `npm` or `yarn` (`options.linked`).
You can provide a prefix to import module with given name or alternative name with a prefix, which my be useful to support plugin modules
with optional short names.
**CAUTION:** In normal conditions, importing a global module is an anti-pattern. Don't import global modules if you don't have a reason.
Possible reasons to use this module:
- Your CLI is installed globally and you want to support a modular plugin structure, so you have to use globally installed plugin modules.
- Your library is installed globally and you want to support optional modules installed globally.
# API
import-glocal
# import-glocal
## Table of contents
### Functions
- [default](#default)
## Functions
### default
▸ **default**(`module`: _string_, `__namedParameters?`: { `force?`: _boolean_ ; `linked?`: _boolean_ ; `prefix?`: _string_ \| _string_[] }): _Promise_
Imports the given module or module prefixed with one of the prefixes. If the module is installed globally,
tries to import globally installed modules by `npm` or `yarn`.
#### Example
```typescript
await importModule("example", { prefix: ["pgen-", "pg-generator-"] }); // Tries to import `example`, `pgen-example`, `pg-generator-example`.
await importModule("example", { force: true }); // Import global module even parnet module is not installed globally.
await importModule string>("example"); // Type of export.
```
**`throws`** an error if the module or prefixed modules cannot be found locally or globally.
#### Type parameters:
| Name | Type | Default | Description |
| ---- | --------- | ------- | ---------------------------------------- |
| `T` | _unknown_ | _any_ | is the exported value from given module. |
#### Parameters:
• **module**: _string_
is the module to import.
• **\_\_namedParameters**: _object_
| Name | Type | Description |
| --------- | ---------------------- | ------------------------------------------------------------------------------------------- |
| `force?` | _boolean_ | is whether to import global modules even parent is not a global module. |
| `linked?` | _boolean_ | is whether to import global modules for linked modules. |
| `prefix?` | _string_ \| _string_[] | is a prefix or a list of prefixes to get additional module names that begins with a prefix. |
**Returns:** _Promise_
Defined in: index.ts:22