yuzu-utils

utility functions for the yuzu library ecosystem

• Installation
  • As NPM Package
  • CDN Delivered <script>
  • ES2017 Syntax
• Browser Support
• Documentation
• Contributing

Installation

As NPM Package

npm install yuzu-utils --save

# or

yarn add yuzu-utils

CDN Delivered <script>

Add the following script tag before your code

<script src="https://unpkg.com/yuzu-utils"></script>

Yuzu utils will be available in the global scope under YZ.Utils.

Note The UMD build of yuzu already ships with built-in utils under the YZ.Utils namespace.

ES2017 Syntax

To provide maximum compatibility with every development environment, packages are transpiled to ES5. When used with a bundler like Webpack or rollup the module resolution system will automatically pick either the Commonjs or ESM version based on your configuration.

If you want to import the ES2017 version of a package you can do so by setting an alias on the bundler's configuration file:

Webpack

// webpack.config.js

module.exports = {
  // ...
+  resolve: {
+    alias: {
+      'yuzu-utils': 'yuzu-utils/dist/index.next.js'
+    }
+  }
}

Rollup

Use rollup-plugin-alias

// rollup.config.js
+ import path from 'path';
+ import alias from 'rollup-plugin-alias';

export default {
  input: './src/index.js',
  plugins: [
    // ...
+    alias({
+      'yuzu-utils': path.resolve(__dirname, 'node_modules/yuzu-utils/dist/index.next.js')
+    })
  ],
};

Browser Support

Yuzu works in all modern browsers. In order to make it work in browsers that don't support ES2015+ features (like IE11) you need to include the yuzu-polyfills package before any other yuzu* package.

If you're using a package bundler add this line at the very top of your entry point:

import 'yuzu-polyfills';

Documentation

Learn more about Yuzu utils! Browse the API.

Contributing

1. Fork it or clone the repo
2. Install dependencies yarn install
3. Code your changes and write new tests in the test folder.
4. Ensure everything is fine by running yarn build
5. Push it or submit a pull request :D