@paychex/platform-browser

Provides agnostic JavaScript functionality for use in all browser-based applications.

Usage no npm install needed!

<script type="module">
  import paychexPlatformBrowser from 'https://cdn.skypack.dev/@paychex/platform-browser';
</script>

README

@paychex/platform-browser

Provides agnostic JavaScript functionality for use in all browser-based applications.

Installation

npm install @paychex/platform-browser

Importing

esm

import { crossOrigin, stores } from '@paychex/platform-browser';

cjs

const { crossOrigin, stores } = require('@paychex/platform-browser');

amd

define(['@paychex/platform-browser'], function(browser) { ... });
define(['@paychex/platform-browser'], function({ crossOrigin, stores }) { ... });

require(['@paychex/platform-browser'], function(browser) { ... });
require(['@paychex/platform-browser'], function({ crossOrigin, stores }) { ... });

iife (browser)

const { crossOrigin, stores } = window['@paychex/platform-browser'];

Commands

To install the necessary dependencies:

npm install

To generate documentation files:

npm run docs

Modules

The @paychex/platform-browser library contains functionality separated into various modules:

name description
[crossOrigin]{@link module:crossOrigin} Enables safe asynchronous communication across different origins.
[stores]{@link module:stores} Provides browser-specific Stores to persist and retrieve data on the user's machine.