Skip to content

Commit 4a58e68

Browse files
dbarnespaychexdbarnespaychex
committed
feat: add utils module
Merge in HTML5/paychex-platform-browser from feature/HMAP-114215 to master Squashed commit of the following: commit 998ce63a363b4dcd2ff86b060ab286b05bce328f Author: Brendan O'Connor <[email protected]> Date: Wed Mar 30 13:53:43 2022 -0400 feat(utils): add utils module Creation of the utils module as well as an svgId() utility function for ensuring svgs with <defs> that have ids will be unique in the document. commit be74374e0831249f94c0d39631f0ae78d10db265 Author: Brendan O'Connor <[email protected]> Date: Wed Mar 30 08:31:59 2022 -0400 feat(utils): add utils module Creation of the utils module as well as an svgId() utility function for ensuring svgs with <defs> that have ids will be unique in the document. commit 2818f13714880a957e996e797fb7a1a13160d8bc Author: Brendan O'Connor <[email protected]> Date: Mon Mar 28 15:21:12 2022 -0400 feat(utils): add utils module Creation of the utils module as well as an svgId() utility function for ensuring svgs with <defs> that have ids will be unique in the document.
1 parent 09ccb55 commit 4a58e68

18 files changed

+171
-18
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ coverage/
33
types/
44
node_modules/
55
package-lock.json
6+
.idea

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,6 @@ The @paychex/platform-browser library contains functionality separated into vari
6060

6161
name | description
6262
:--- | :---
63+
[utils]{@link utils} | A collection of helpful utilities
6364
[crossOrigin]{@link crossOrigin} | Enables safe asynchronous communication across different origins.
6465
[stores]{@link stores} | Provides browser-specific Stores to persist and retrieve data on the user's machine.

‎docs/assets/main.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/index.html

+5-1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ <h2>Modules</h2>
6262
</tr>
6363
</thead>
6464
<tbody><tr>
65+
<td align="left"><a href="modules/utils.html">utils</a></td>
66+
<td align="left">A collection of helpful utilities</td>
67+
</tr>
68+
<tr>
6569
<td align="left"><a href="modules/crossOrigin.html">crossOrigin</a></td>
6670
<td align="left">Enables safe asynchronous communication across different origins.</td>
6771
</tr>
@@ -70,4 +74,4 @@ <h2>Modules</h2>
7074
<td align="left">Provides browser-specific Stores to persist and retrieve data on the user&#39;s machine.</td>
7175
</tr>
7276
</tbody></table>
73-
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/crossOrigin.html">cross<wbr/>Origin</a></li><li class=" tsd-kind-namespace"><a href="modules/stores.html">stores</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class=""><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>
77+
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/crossOrigin.html">cross<wbr/>Origin</a></li><li class=" tsd-kind-namespace"><a href="modules/stores.html">stores</a></li><li class=" tsd-kind-namespace"><a href="modules/utils.html">utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class=""><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>

‎docs/interfaces/crossOrigin.CrossOriginEnvelope.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CrossOriginEnvelope | @paychex/platform-browser</title><meta name="description" content="Documentation for @paychex/platform-browser"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@paychex/platform-browser</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@paychex/platform-browser</a></li><li><a href="../modules/crossOrigin.html">crossOrigin</a></li><li><a href="crossOrigin.CrossOriginEnvelope.html">CrossOriginEnvelope</a></li></ul><h1>Interface CrossOriginEnvelope</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CrossOriginEnvelope</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#transfers" class="tsd-kind-icon">transfers</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link">message<a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in crossOrigin/index.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transfers<a href="#transfers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">transfers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in crossOrigin/index.ts:40</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/crossOrigin.html">cross<wbr/>Origin</a></li><li class=" tsd-kind-namespace"><a href="../modules/stores.html">stores</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="crossOrigin.CrossOriginEnvelope.html" class="tsd-kind-icon">Cross<wbr/>Origin<wbr/>Envelope</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#transfers" class="tsd-kind-icon">transfers</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CrossOriginEnvelope | @paychex/platform-browser</title><meta name="description" content="Documentation for @paychex/platform-browser"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@paychex/platform-browser</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@paychex/platform-browser</a></li><li><a href="../modules/crossOrigin.html">crossOrigin</a></li><li><a href="crossOrigin.CrossOriginEnvelope.html">CrossOriginEnvelope</a></li></ul><h1>Interface CrossOriginEnvelope</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CrossOriginEnvelope</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#transfers" class="tsd-kind-icon">transfers</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link">message<a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in crossOrigin/index.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transfers<a href="#transfers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">transfers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in crossOrigin/index.ts:40</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/crossOrigin.html">cross<wbr/>Origin</a></li><li class=" tsd-kind-namespace"><a href="../modules/stores.html">stores</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="crossOrigin.CrossOriginEnvelope.html" class="tsd-kind-icon">Cross<wbr/>Origin<wbr/>Envelope</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="crossOrigin.CrossOriginEnvelope.html#transfers" class="tsd-kind-icon">transfers</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)