sportradar-api-client
Version:
Node and NestJS wrappers for Sportradar feeds
13 lines • 23.3 kB
HTML
<html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AsyncConfiguration | sportradar-api-client</title><meta name="description" content="Documentation for sportradar-api-client"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">sportradar-api-client</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">sportradar-api-client</a></li><li><a href="../modules/index.html">index</a></li><li><a href="../modules/index.SportradarNflApi.html">SportradarNflApi</a></li><li><a href="index.SportradarNflApi.AsyncConfiguration.html">AsyncConfiguration</a></li></ul><h1>Interface AsyncConfiguration</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AsyncConfiguration</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="index.SportradarNflApi.AsyncConfiguration.html#imports">imports</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">Type</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DynamicModule</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DynamicModule</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ForwardReference</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="index.SportradarNflApi.AsyncConfiguration.html#inject">inject</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="index.SportradarNflApi.AsyncConfiguration.html#useClass">useClass</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Type</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="index.SportradarNflApi.ConfigurationFactory.html" class="tsd-signature-type tsd-kind-interface">ConfigurationFactory</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="index.SportradarNflApi.AsyncConfiguration.html#useExisting">useExisting</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Type</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="index.SportradarNflApi.ConfigurationFactory.html" class="tsd-signature-type tsd-kind-interface">ConfigurationFactory</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="index.SportradarNflApi.AsyncConfiguration.html#useFactory">useFactory</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ModuleMetadata</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"imports"</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">AsyncConfiguration</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/gfay63/sportradar-api-client/blob/c9a70e9a3ba244c20c1b7bb5a78f228e0b44f18b/src/sportradar_nfl/configuration.ts#L87">src/sportradar_nfl/configuration.ts:87</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="index.SportradarNflApi.AsyncConfiguration.html#imports" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>imports?</span></a>
<a href="index.SportradarNflApi.AsyncConfiguration.html#inject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inject?</span></a>
<a href="index.SportradarNflApi.AsyncConfiguration.html#useClass" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Class?</span></a>
<a href="index.SportradarNflApi.AsyncConfiguration.html#useExisting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Existing?</span></a>
<a href="index.SportradarNflApi.AsyncConfiguration.html#useFactory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Factory?</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="imports" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>imports</span><a href="#imports" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">imports</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">Type</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DynamicModule</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DynamicModule</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ForwardReference</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Optional list of imported modules that export the providers which are
required in this module.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Pick.imports</p><ul><li>Defined in node_modules/@nestjs/common/interfaces/modules/module-metadata.interface.d.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>inject</span><a href="#inject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Optional list of providers to be injected into the context of the Factory function.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/gfay63/sportradar-api-client/blob/c9a70e9a3ba244c20c1b7bb5a78f228e0b44f18b/src/sportradar_nfl/configuration.ts#L104">src/sportradar_nfl/configuration.ts:104</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="useClass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>use<wbr/>Class</span><a href="#useClass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use<wbr/>Class</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Type</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="index.SportradarNflApi.ConfigurationFactory.html" class="tsd-signature-type tsd-kind-interface">ConfigurationFactory</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>The <code>useClass</code> syntax allows you to dynamically determine a class
that a token should resolve to.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/gfay63/sportradar-api-client/blob/c9a70e9a3ba244c20c1b7bb5a78f228e0b44f18b/src/sportradar_nfl/configuration.ts#L96">src/sportradar_nfl/configuration.ts:96</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="useExisting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>use<wbr/>Existing</span><a href="#useExisting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use<wbr/>Existing</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Type</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="index.SportradarNflApi.ConfigurationFactory.html" class="tsd-signature-type tsd-kind-interface">ConfigurationFactory</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>The <code>useExisting</code> syntax allows you to create aliases for existing providers.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/gfay63/sportradar-api-client/blob/c9a70e9a3ba244c20c1b7bb5a78f228e0b44f18b/src/sportradar_nfl/configuration.ts#L91">src/sportradar_nfl/configuration.ts:91</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="useFactory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>use<wbr/>Factory</span><a href="#useFactory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">use<wbr/>Factory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>The <code>useFactory</code> syntax allows for creating providers dynamically.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useFactory.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/index.SportradarNflApi.html" class="tsd-signature-type tsd-kind-namespace">SportradarNflApi</a><span class="tsd-signature-symbol">.</span><a href="../classes/index.SportradarNflApi.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/gfay63/sportradar-api-client/blob/c9a70e9a3ba244c20c1b7bb5a78f228e0b44f18b/src/sportradar_nfl/configuration.ts#L100">src/sportradar_nfl/configuration.ts:100</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#imports" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>imports</span></a><a href="#inject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inject</span></a><a href="#useClass" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Class</span></a><a href="#useExisting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Existing</span></a><a href="#useFactory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Factory</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>sportradar-api-client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>