Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kabirbaidhya/get-js
A lightweight library to asynchronously load scripts on the fly
https://github.com/kabirbaidhya/get-js
angular async get javascript js loader loading promise script
Last synced: about 2 months ago
JSON representation
A lightweight library to asynchronously load scripts on the fly
- Host: GitHub
- URL: https://github.com/kabirbaidhya/get-js
- Owner: kabirbaidhya
- License: mit
- Created: 2016-04-26T15:59:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:49:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T02:14:38.738Z (2 months ago)
- Topics: angular, async, get, javascript, js, loader, loading, promise, script
- Language: JavaScript
- Homepage: https://yarn.pm/get-js
- Size: 667 KB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nepal - get-js - A lightweight promise based package to load scripts on the fly (Uncategorized / Uncategorized)
README
# get-js
[](https://www.npmjs.com/package/get-js)
[](https://www.npmjs.com/package/get-js)
[](LICENSE)
[](https://travis-ci.org/kabirbaidhya/get-js)
A lightweight library to asynchronously load scripts on the fly.
## Installation
```bash
# Using npm
$ npm install get-js --save
# Using Yarn
$ yarn add get-js
# Using Bower
$ bower install get-js --save
```
For [older browsers](http://caniuse.com/#feat=promises) you may also need a [promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise) polyfill.
```bash
# Install promise polyfill.
$ npm install es6-promise
```
## Usage
Use it in your project with `require` or `import` as an ES module.
```javascript
const get = require('get-js');
// ES2015+
import get from 'get-js';
```
Or, using `` tags:
```html
<script type="text/javascript" src="https://unpkg.com/[email protected]/dist/get.min.js">
```
Here you go:
```javascript
// Load a single script
get('https://code.jquery.com/jquery-3.4.1.min.js').then(function() {
console.log('do something');
});
// Load multiple scripts, without changing the order
get(['/js/abc.js', '/js/xyz.js'])
.then(function() {
console.log('do something now');
})
.catch(function() {
console.log('error');
});
```
If you're using ES2015+ / TypeScript codebase, you can also use `async` / `await` syntax with `get`:
```js
import get from 'get-js';
(async () => {
await get('https://code.jquery.com/jquery-3.4.1.min.js'); // Gets jQuery.
$(document).on('ready', () => {
console.log('Ready!');
});
})();
```
## Using with Angular
**Note: This refers to [angular 1.x](https://angularjs.org/) projects.**
You can inject this in your angular code as a service.
Require the angular module using
```javascript
const angularGetJs = require('get-js/angular');
```
Or
```html
```
Then you should be able to use it like this:
```javascript
// Add the module as a dependency in your app.
angular.module('app', ['angularGetJs']);
// Inject the service
angular.module('app').controller('MyController', [
'get',
function(get) {
get('/some/script.js')
.then(function() {
console.log('do something now');
})
.catch(function() {
console.log('error');
});
}
]);
```
## Development
To start developing or contributing to `get-js`, you'll need to clone the project first.
1. Clone it locally.
```
$ git clone [email protected]:kabirbaidhya/get-js.git
```
2. Install dependencies.
```
$ yarn
```
3. Linting
```
$ yarn lint
```
4. Generating a build.
```
$ yarn build
```
## License
This package is licensed under the [MIT License](LICENSE).