https://github.com/jonathanong/load-script

Script loader with promise & requestIdleCallback support
https://github.com/jonathanong/load-script

Last synced: 4 months ago
JSON representation

Script loader with promise & requestIdleCallback support

• Host: GitHub
• URL: https://github.com/jonathanong/load-script
• Owner: jonathanong
• Created: 2018-03-07T14:44:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-29T04:38:12.000Z (about 5 years ago)
• Last Synced: 2024-12-31T16:19:30.279Z (5 months ago)
• Language: JavaScript
• Size: 59.6 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# @jongleberry/load-script

[![Build Status](https://travis-ci.org/jonathanong/load-script.svg?branch=master)](https://travis-ci.org/jonathanong/load-script)

[![codecov](https://codecov.io/gh/jonathanong/load-script/branch/master/graph/badge.svg)](https://codecov.io/gh/jonathanong/load-script)

[![Greenkeeper badge](https://badges.greenkeeper.io/jonathanong/load-script.svg)](https://greenkeeper.io/)

Script loader with:

- `Promise` support

- `requestIdleCallback` support

Installation:

```bash

npm install --save-dev @jongleberry/load-script

```

Example:

```js

import loadScript from '@jongleberry/load-script'

loadScript('https://www.googletagmanager.com/ns.html?id=GTM-XXXX', {

  timeout: 1000

}).catch((err) => {

  console.error(err.stack)

})

```

## API

### const script = await loadScript(src [, options])

- `src` - JS source URL

- `options`:

  - `type`

  - `charset`

  - `id`

  - `noModule`

  - `async`

  - `defer`

  - `timeout` - timeout passed to `requestIdleCallback`, falling back to `setTimeout`. Set to 0 to load JS in at least the next tick.

Returns the script element when it's resolved.