Update popclip.d.ts

update all .ts files to fix type errors rebuild all js rebuild JS API docs rebuild JSON schema
pilotmoon · Sep 17, 2023 · bd05319 · bd05319
1 parent 07123c1
commit bd05319
Show file tree

Hide file tree

Showing 115 changed files with 654 additions and 1,999 deletions.
diff --git a/ExtensionSchema.json b/ExtensionSchema.json
diff --git a/README-js.md b/README-js.md
@@ -1,12 +1,5 @@
-# Under Construction
+This documentation describes the API available to PopClip's JavaScript actions and module-based extensions.
 
-![classic under construction gif](https://raw.github.com/pilotmoon/PopClip-Extensions/master/docs-assets/construction.gif)
+It is auto-generated from the TypeScript definitions file, popclip.d.ts.
 
-This is work-in-progress documentation for PopClip's JavaScript programming interface. It's a bit rough and ready, please bear with my while I complete the docs.
-
-Beware that some of it might be inaccurate because I have evolved the API over time and documented as I went.
-
-This documentation is auto-generated from the popclip.d.ts file in the repo. This is a TypeScript definitions file which can be used with a TypeScript
-compatible editor such as VS.Code for correctness checking and autocompletion.
-
-A good starting point is probably the [PopClip](https://pilotmoon.github.io/PopClip-Extensions/interfaces/PopClip.html) object.
+A good starting point is the [PopClip](./interfaces/PopClip.html) object.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -13,18 +13,14 @@
     --dark-hl-5: #B5CEA8;
     --light-hl-6: #267F99;
     --dark-hl-6: #4EC9B0;
-    --light-hl-7: #0000FF;
-    --dark-hl-7: #569CD6;
-    --light-hl-8: #0070C1;
-    --dark-hl-8: #4FC1FF;
-    --light-hl-9: #811F3F;
-    --dark-hl-9: #D16969;
-    --light-hl-10: #0451A5;
-    --dark-hl-10: #9CDCFE;
-    --light-hl-11: #000000FF;
-    --dark-hl-11: #D4D4D4;
-    --light-hl-12: #AF00DB;
-    --dark-hl-12: #C586C0;
+    --light-hl-7: #811F3F;
+    --dark-hl-7: #D16969;
+    --light-hl-8: #0000FF;
+    --dark-hl-8: #569CD6;
+    --light-hl-9: #000000FF;
+    --dark-hl-9: #D4D4D4;
+    --light-hl-10: #0070C1;
+    --dark-hl-10: #4FC1FF;
     --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }
@@ -41,8 +37,6 @@
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
     --hl-10: var(--light-hl-10);
-    --hl-11: var(--light-hl-11);
-    --hl-12: var(--light-hl-12);
     --code-background: var(--light-code-background);
 } }
 
@@ -58,8 +52,6 @@
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
     --hl-10: var(--dark-hl-10);
-    --hl-11: var(--dark-hl-11);
-    --hl-12: var(--dark-hl-12);
     --code-background: var(--dark-code-background);
 } }
 
@@ -75,8 +67,6 @@ body.light {
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
     --hl-10: var(--light-hl-10);
-    --hl-11: var(--light-hl-11);
-    --hl-12: var(--light-hl-12);
     --code-background: var(--light-code-background);
 }
 
@@ -92,8 +82,6 @@ body.dark {
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
     --hl-10: var(--dark-hl-10);
-    --hl-11: var(--dark-hl-11);
-    --hl-12: var(--dark-hl-12);
     --code-background: var(--dark-code-background);
 }
 
@@ -108,6 +96,4 @@ body.dark {
 .hl-8 { color: var(--hl-8); }
 .hl-9 { color: var(--hl-9); }
 .hl-10 { color: var(--hl-10); }
-.hl-11 { color: var(--hl-11); }
-.hl-12 { color: var(--hl-12); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -766,12 +766,13 @@ footer .tsd-legend {
 
 .tsd-flag {
     display: inline-block;
-    padding: 1px 5px;
+    padding: 0.25em 0.4em;
     border-radius: 4px;
     color: var(--color-comment-tag-text);
     background-color: var(--color-comment-tag);
     text-indent: 0;
-    font-size: 14px;
+    font-size: 75%;
+    line-height: 1;
     font-weight: normal;
 }
 

diff --git a/docs/index.html b/docs/index.html
@@ -1,11 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PopClip Extensions JavaScript Reference</title><meta name="description" content="Documentation for PopClip Extensions JavaScript Reference"/><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">PopClip Extensions JavaScript Reference</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></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"><h1>PopClip Extensions JavaScript Reference</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
-<a href="#under-construction" id="under-construction" style="color: inherit; text-decoration: none;">
-  <h1>Under Construction</h1>
-</a>
-<p><img src="https://raw.github.com/pilotmoon/PopClip-Extensions/master/docs-assets/construction.gif" alt="classic under construction gif"></p>
-<p>This is work-in-progress documentation for PopClip&#39;s JavaScript programming interface. It&#39;s a bit rough and ready, please bear with my while I complete the docs.</p>
-<p>Beware that some of it might be inaccurate because I have evolved the API over time and documented as I went.</p>
-<p>This documentation is auto-generated from the popclip.d.ts file in the repo. This is a TypeScript definitions file which can be used with a TypeScript
-compatible editor such as VS.Code for correctness checking and autocompletion.</p>
-<p>A good starting point is probably the <a href="https://pilotmoon.github.io/PopClip-Extensions/interfaces/PopClip.html">PopClip</a> object.</p>
-</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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias"><a href="modules.html#Action" class="tsd-kind-icon">Action</a></li><li class="tsd-kind-interface"><a href="interfaces/ActionFlags.html" class="tsd-kind-icon">Action<wbr/>Flags</a></li><li class="tsd-kind-interface"><a href="interfaces/ActionFunction.html" class="tsd-kind-icon">Action<wbr/>Function</a></li><li class="tsd-kind-interface"><a href="interfaces/ActionObject.html" class="tsd-kind-icon">Action<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/ActionProperties.html" class="tsd-kind-icon">Action<wbr/>Properties</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AfterStep" class="tsd-kind-icon">After<wbr/>Step</a></li><li class="tsd-kind-interface"><a href="interfaces/AssociatedApp.html" class="tsd-kind-icon">Associated<wbr/>App</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AuthFlowFunction" class="tsd-kind-icon">Auth<wbr/>Flow<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AuthFunction" class="tsd-kind-icon">Auth<wbr/>Function</a></li><li class="tsd-kind-interface"><a href="interfaces/AuthInfo.html" class="tsd-kind-icon">Auth<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BeforeStep" class="tsd-kind-icon">Before<wbr/>Step</a></li><li class="tsd-kind-interface"><a href="interfaces/Context.html" class="tsd-kind-icon">Context</a></li><li class="tsd-kind-interface"><a href="interfaces/Extension.html" class="tsd-kind-icon">Extension</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IconString" class="tsd-kind-icon">Icon<wbr/>String</a></li><li class="tsd-kind-interface"><a href="interfaces/Input.html" class="tsd-kind-icon">Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LocalizableString" class="tsd-kind-icon">Localizable<wbr/>String</a></li><li class="tsd-kind-interface"><a href="interfaces/Modifiers.html" class="tsd-kind-icon">Modifiers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NegatedRequirement" class="tsd-kind-icon">Negated<wbr/>Requirement</a></li><li class="tsd-kind-interface"><a href="interfaces/Option.html" class="tsd-kind-icon">Option</a></li><li class="tsd-kind-interface"><a href="interfaces/Options.html" class="tsd-kind-icon">Options</a></li><li class="tsd-kind-interface"><a href="interfaces/Pasteboard.html" class="tsd-kind-icon">Pasteboard</a></li><li class="tsd-kind-interface"><a href="interfaces/PasteboardContent.html" class="tsd-kind-icon">Pasteboard<wbr/>Content</a></li><li class="tsd-kind-interface"><a href="interfaces/PopClip.html" class="tsd-kind-icon">Pop<wbr/>Clip</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PopulationFunction" class="tsd-kind-icon">Population<wbr/>Function</a></li><li class="tsd-kind-interface"><a href="interfaces/Range.html" class="tsd-kind-icon">Range</a></li><li class="tsd-kind-interface"><a href="interfaces/RangedStrings.html" class="tsd-kind-icon">Ranged<wbr/>Strings</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Requirement" class="tsd-kind-icon">Requirement</a></li><li class="tsd-kind-interface"><a href="interfaces/StringTable.html" class="tsd-kind-icon">String<wbr/>Table</a></li><li class="tsd-kind-interface"><a href="interfaces/Util.html" class="tsd-kind-icon">Util</a></li><li class="tsd-kind-function"><a href="modules.html#defineExtension" class="tsd-kind-icon">define<wbr/>Extension</a></li><li class="tsd-kind-variable"><a href="modules.html#pasteboard" class="tsd-kind-icon">pasteboard</a></li><li class="tsd-kind-variable"><a href="modules.html#popclip" class="tsd-kind-icon">popclip</a></li><li class="tsd-kind-function"><a href="modules.html#print" class="tsd-kind-icon">print</a></li><li class="tsd-kind-function"><a href="modules.html#require" class="tsd-kind-icon">require</a></li><li class="tsd-kind-variable"><a href="modules.html#util" class="tsd-kind-icon">util</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PopClip JavaScript API Reference</title><meta name="description" content="Documentation for PopClip JavaScript API Reference"/><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">PopClip JavaScript API Reference</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></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"><h1>PopClip JavaScript API Reference </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p>This documentation describes the API available to PopClip&#39;s JavaScript actions and module-based extensions.</p>
+<p>It is auto-generated from the TypeScript definitions file, popclip.d.ts.</p>
+<p>A good starting point is the <a href="./interfaces/PopClip.html">PopClip</a> object.</p>
+</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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Action.html" class="tsd-kind-icon">Action</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ActionFunction" class="tsd-kind-icon">Action<wbr/>Function</a></li><li class="tsd-kind-interface"><a href="interfaces/ActionProperties.html" class="tsd-kind-icon">Action<wbr/>Properties</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AfterStep" class="tsd-kind-icon">After<wbr/>Step</a></li><li class="tsd-kind-interface"><a href="interfaces/AssociatedApp.html" class="tsd-kind-icon">Associated<wbr/>App</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AuthFlowFunction" class="tsd-kind-icon">Auth<wbr/>Flow<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AuthFunction" class="tsd-kind-icon">Auth<wbr/>Function</a></li><li class="tsd-kind-interface"><a href="interfaces/AuthInfo.html" class="tsd-kind-icon">Auth<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/AuthOptions.html" class="tsd-kind-icon">Auth<wbr/>Options</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BeforeStep" class="tsd-kind-icon">Before<wbr/>Step</a></li><li class="tsd-kind-interface"><a href="interfaces/Context.html" class="tsd-kind-icon">Context</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Extension.html" class="tsd-kind-icon">Extension</a></li><li class="tsd-kind-interface"><a href="interfaces/IconProperties.html" class="tsd-kind-icon">Icon<wbr/>Properties</a></li><li class="tsd-kind-interface"><a href="interfaces/Input.html" class="tsd-kind-icon">Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LocalizableString" class="tsd-kind-icon">Localizable<wbr/>String</a></li><li class="tsd-kind-interface"><a href="interfaces/Modifiers.html" class="tsd-kind-icon">Modifiers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NegatedRequirement" class="tsd-kind-icon">Negated<wbr/>Requirement</a></li><li class="tsd-kind-interface"><a href="interfaces/Option.html" class="tsd-kind-icon">Option</a></li><li class="tsd-kind-interface"><a href="interfaces/Options.html" class="tsd-kind-icon">Options</a></li><li class="tsd-kind-interface"><a href="interfaces/PasteOptions.html" class="tsd-kind-icon">Paste<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/Pasteboard.html" class="tsd-kind-icon">Pasteboard</a></li><li class="tsd-kind-interface"><a href="interfaces/PasteboardContent.html" class="tsd-kind-icon">Pasteboard<wbr/>Content</a></li><li class="tsd-kind-interface"><a href="interfaces/PopClip.html" class="tsd-kind-icon">Pop<wbr/>Clip</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#PopulationFunction" class="tsd-kind-icon">Population<wbr/>Function</a></li><li class="tsd-kind-interface"><a href="interfaces/Range.html" class="tsd-kind-icon">Range</a></li><li class="tsd-kind-interface"><a href="interfaces/RangedStrings.html" class="tsd-kind-icon">Ranged<wbr/>Strings</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Requirement" class="tsd-kind-icon">Requirement</a></li><li class="tsd-kind-interface"><a href="interfaces/StringTable.html" class="tsd-kind-icon">String<wbr/>Table</a></li><li class="tsd-kind-interface"><a href="interfaces/Util.html" class="tsd-kind-icon">Util</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#defineExtension" class="tsd-kind-icon">define<wbr/>Extension</a></li><li class="tsd-kind-variable"><a href="modules.html#pasteboard" class="tsd-kind-icon">pasteboard</a></li><li class="tsd-kind-variable"><a href="modules.html#popclip" class="tsd-kind-icon">popclip</a></li><li class="tsd-kind-function"><a href="modules.html#print" class="tsd-kind-icon">print</a></li><li class="tsd-kind-function"><a href="modules.html#require" class="tsd-kind-icon">require</a></li><li class="tsd-kind-function"><a href="modules.html#sleep" class="tsd-kind-icon">sleep</a></li><li class="tsd-kind-variable"><a href="modules.html#util" class="tsd-kind-icon">util</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>