ComputerSurge/shields
3
0
Fork 0
Code Pull Requests 1 Activity
Files
dade25199f0afaaf16741fc7e33cd7c544bdd683
shields/global.html
github-merge-queue[bot] dade25199f Deploying to gh-pages from @ badges/shields@834e4e1f96 🚀
2025-03-16 20:33:30 +00:00

1885 lines
30 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="createNumRequestCounter"><span class="type-signature"></span>createNumRequestCounter<span class="signature">(attrs)</span><span class="type-signature"> &rarr; {object}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Refer to individual attrs</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>category</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>e.g: 'build'</p></td>
</tr>
<tr>
<td class="name"><code>serviceFamily</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>e.g: 'npm'</p></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>e.g: 'NpmVersion'</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_server_prometheus-metrics.js.html">core/server/prometheus-metrics.js</a>, <a href="core_server_prometheus-metrics.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p><code>{ inc() {} }</code>.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="fakeJwtToken"><span class="type-signature"></span>fakeJwtToken<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
<p>Generate a fake JWT Token valid for 1 hour for use in testing.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_test-helpers.js.html">services/test-helpers.js</a>, <a href="services_test-helpers.js.html#line187">line 187</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Fake JWT Token valid for 1 hour.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="generateFakeConfig"><span class="type-signature"></span>generateFakeConfig<span class="signature">(serviceClass, fakeKey, fakeUser, fakeauthorizedOrigins)</span><span class="type-signature"> &rarr; {object}</span></h4>
<div class="description">
<p>Generates a configuration object with a fake key based on the provided class.
For use in auth tests where a config with a test key is required.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>serviceClass</code></td>
<td class="type">
<span class="param-type">BaseService</span>
</td>
<td class="description last"><p>The class to generate configuration for.</p></td>
</tr>
<tr>
<td class="name"><code>fakeKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The fake key to be used in the configuration.</p></td>
</tr>
<tr>
<td class="name"><code>fakeUser</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Optional, The fake user to be used in the configuration.</p></td>
</tr>
<tr>
<td class="name"><code>fakeauthorizedOrigins</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>authorizedOrigins to add to config.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_test-helpers.js.html">services/test-helpers.js</a>, <a href="services_test-helpers.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<ul>
<li>Throws an error if the input is not a class.</li>
</ul>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">TypeError</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>The configuration object.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="getBadgeExampleCall"><span class="type-signature"></span>getBadgeExampleCall<span class="signature">(serviceClass)</span><span class="type-signature"> &rarr; {object}</span></h4>
<div class="description">
<p>Retrieves an example set of parameters for invoking a service class using OpenAPI example of that class.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>serviceClass</code></td>
<td class="type">
<span class="param-type">BaseService</span>
</td>
<td class="description last"><p>The service class containing OpenAPI specifications.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_test-helpers.js.html">services/test-helpers.js</a>, <a href="services_test-helpers.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<ul>
<li>Throws a TypeError if the input <code>serviceClass</code> is not an instance of BaseService,
or if it lacks the expected structure.</li>
</ul>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">TypeError</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object with call params to use with a service invoke of the first OpenAPI example.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>// Example usage:
const example = getBadgeExampleCall(StackExchangeReputation)
console.log(example)
// Output: { stackexchangesite: 'stackoverflow', query: '123' }
StackExchangeReputation.invoke(defaultContext, config, example)</code></pre>
<h4 class="name" id="getServiceClassAuthOrigin"><span class="type-signature"></span>getServiceClassAuthOrigin<span class="signature">(serviceClass)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
<p>Returns the first auth origin found for a provided service class.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>serviceClass</code></td>
<td class="type">
<span class="param-type">BaseService</span>
</td>
<td class="description last"><p>The service class to find the authorized origins.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_test-helpers.js.html">services/test-helpers.js</a>, <a href="services_test-helpers.js.html#line163">line 163</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<ul>
<li>Throws a TypeError if the input <code>serviceClass</code> is not an instance of BaseService.</li>
</ul>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">TypeError</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>First auth origin found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>// Example usage:
getServiceClassAuthOrigin(Obs)
// outputs 'https://api.opensuse.org'</code></pre>
<h4 class="name" id="isMetricWithPattern"><span class="type-signature"></span>isMetricWithPattern<span class="signature">(nestedRegexp)</span><span class="type-signature"> &rarr; {function}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nestedRegexp</code></td>
<td class="type">
<span class="param-type">RegExp</span>
</td>
<td class="description last"><p>Pattern that must appear after the metric.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_test-validators.js.html">services/test-validators.js</a>, <a href="services_test-validators.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A function that returns a RegExp that matches a metric followed by another pattern.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
<h4 class="name" id="module:services/dynamic/json-path"><span class="type-signature"></span>module:services/dynamic/json-path<span class="signature">(superclass)</span><span class="type-signature"> &rarr; {function}</span></h4>
<div class="description">
<p>Dynamic service class factory which wraps <a href="module-core_base-service_base-BaseService.html">module:core/base-service/base~BaseService</a> with support of <a href="https://jsonpath.com/">JSONPath</a>.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>superclass</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>class to extend</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_dynamic_json-path.js.html">services/dynamic/json-path.js</a>, <a href="services_dynamic_json-path.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>wrapped class</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
<h4 class="name" id="testAuth"><span class="type-signature">(async) </span>testAuth<span class="signature">(serviceClass, authMethod, dummyResponse, options)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Test authentication of a badge for it's first OpenAPI example using a provided dummyResponse and authentication method.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>serviceClass</code></td>
<td class="type">
<span class="param-type">BaseService</span>
</td>
<td class="description last"><p>The service class tested.</p></td>
</tr>
<tr>
<td class="name"><code>authMethod</code></td>
<td class="type">
<span class="param-type">'BasicAuth'</span>
|
<span class="param-type">'ApiKeyHeader'</span>
|
<span class="param-type">'BearerAuthHeader'</span>
|
<span class="param-type">'QueryStringAuth'</span>
|
<span class="param-type">'JwtAuth'</span>
</td>
<td class="description last"><p>The auth method of the tested service class.</p></td>
</tr>
<tr>
<td class="name"><code>dummyResponse</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>An object containing the dummy response by the server.</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Additional options for non default keys and content-type of the dummy response.</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>contentType</code></td>
<td class="type">
<span class="param-type">'application/xml'</span>
|
<span class="param-type">'application/json'</span>
</td>
<td class="description last"><p>Header for the response, may contain any string.</p></td>
</tr>
<tr>
<td class="name"><code>apiHeaderKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Non default header for ApiKeyHeader auth.</p></td>
</tr>
<tr>
<td class="name"><code>bearerHeaderKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Non default bearer header prefix for BearerAuthHeader.</p></td>
</tr>
<tr>
<td class="name"><code>queryUserKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>QueryStringAuth user key.</p></td>
</tr>
<tr>
<td class="name"><code>queryPassKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>QueryStringAuth pass key.</p></td>
</tr>
<tr>
<td class="name"><code>jwtLoginEndpoint</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>jwtAuth Login endpoint.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="services_test-helpers.js.html">services/test-helpers.js</a>, <a href="services_test-helpers.js.html#line217">line 217</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<ul>
<li>Throws a TypeError if the input <code>serviceClass</code> is not an instance of BaseService,
or if <code>serviceClass</code> is missing authorizedOrigins.</li>
</ul>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">TypeError</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>// Example usage:
testAuth(StackExchangeReputation, QueryStringAuth, { items: [{ reputation: 8 }] })</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-badge-maker_lib_xml.html">badge-maker/lib/xml</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-toml.html">core/base-service/base-toml</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_base-service_openapi.html">core/base-service/openapi</a></li><li><a href="module-core_base-service_resource-cache.html">core/base-service/resource-cache</a></li><li><a href="module-core_base-service_service-definitions.html">core/base-service/service-definitions</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_build-status.html">services/build-status</a></li><li><a href="module-services_color-formatters.html">services/color-formatters</a></li><li><a href="module-services_contributor-count.html">services/contributor-count</a></li><li><a href="module-services_date.html">services/date</a></li><li><a href="module-services_downloads.html">services/downloads</a></li><li><a href="module-services_dynamic-common.html">services/dynamic-common</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_endpoint-common.html">services/endpoint-common</a></li><li><a href="module-services_licenses.html">services/licenses</a></li><li><a href="module-services_package-json-helpers.html">services/package-json-helpers</a></li><li><a href="module-services_php-version.html">services/php-version</a></li><li><a href="module-services_pipenv-helpers.html">services/pipenv-helpers</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_size.html">services/size</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li><li><a href="module-services_text-formatters.html">services/text-formatters</a></li><li><a href="module-services_validators.html">services/validators</a></li><li><a href="module-services_version.html">services/version</a></li><li><a href="module-services_website-status.html">services/website-status</a></li><li><a href="module-services_winget_version.html">services/winget/version</a></li></ul><h3>Classes</h3><ul><li><a href="BaseThunderstoreService.html">BaseThunderstoreService</a></li><li><a href="module-badge-maker_lib_xml-ElementList.html">ElementList</a></li><li><a href="module-badge-maker_lib_xml-XmlElement.html">XmlElement</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-toml-BaseTomlService.html">BaseTomlService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-adding-new-config-values.html">adding-new-config-values</a></li><li><a href="tutorial-authentication.html">authentication</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li><li><a href="tutorial-static-badges.html">static-badges</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createNumRequestCounter">createNumRequestCounter</a></li><li><a href="global.html#fakeJwtToken">fakeJwtToken</a></li><li><a href="global.html#generateFakeConfig">generateFakeConfig</a></li><li><a href="global.html#getBadgeExampleCall">getBadgeExampleCall</a></li><li><a href="global.html#getServiceClassAuthOrigin">getServiceClassAuthOrigin</a></li><li><a href="global.html#isMetricWithPattern">isMetricWithPattern</a></li><li><a href="global.html#testAuth">testAuth</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Mar 16 2025 20:33:29 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
View Git Blame Copy Permalink