Skip to content

Commit 06cc6ae

Browse files
googlemaps-botgooglemaps-bot
committed
feat: add status getter (#488) 0402c78 
1 parent 59d86bf commit 06cc6ae

File tree

13 files changed

+101
-36
lines changed

13 files changed

+101
-36
lines changed

‎assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎classes/Loader.html

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.

‎dist/index.d.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,15 @@ export interface LoaderOptions {
153153
*/
154154
retries?: number;
155155
}
156+
/**
157+
* The status of the [[Loader]].
158+
*/
159+
export declare enum LoaderStatus {
160+
INITIALIZED = 0,
161+
LOADING = 1,
162+
SUCCESS = 2,
163+
FAILURE = 3
164+
}
156165
/**
157166
* [[Loader]] makes it easier to add Google Maps JavaScript API to your application
158167
* dynamically using
@@ -239,6 +248,7 @@ export declare class Loader {
239248
*/
240249
constructor({ apiKey, channel, client, id, libraries, language, region, version, mapIds, nonce, retries, url, }: LoaderOptions);
241250
get options(): LoaderOptions;
251+
get status(): LoaderStatus;
242252
private get failed();
243253
/**
244254
* CreateUrl returns the Google Maps JavaScript API script url given the [[LoaderOptions]].

‎dist/index.dev.js

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2462,6 +2462,18 @@ this.google.maps.plugins.loader = (function (exports) {
24622462
};
24632463

24642464
var DEFAULT_ID = "__googleMapsScriptId";
2465+
/**
2466+
* The status of the [[Loader]].
2467+
*/
2468+
2469+
exports.LoaderStatus = void 0;
2470+
2471+
(function (LoaderStatus) {
2472+
LoaderStatus[LoaderStatus["INITIALIZED"] = 0] = "INITIALIZED";
2473+
LoaderStatus[LoaderStatus["LOADING"] = 1] = "LOADING";
2474+
LoaderStatus[LoaderStatus["SUCCESS"] = 2] = "SUCCESS";
2475+
LoaderStatus[LoaderStatus["FAILURE"] = 3] = "FAILURE";
2476+
})(exports.LoaderStatus || (exports.LoaderStatus = {}));
24652477
/**
24662478
* [[Loader]] makes it easier to add Google Maps JavaScript API to your application
24672479
* dynamically using
@@ -2482,6 +2494,7 @@ this.google.maps.plugins.loader = (function (exports) {
24822494
* ```
24832495
*/
24842496

2497+
24852498
var Loader = /*#__PURE__*/function () {
24862499
/**
24872500
* Creates an instance of Loader using [[LoaderOptions]]. No defaults are set
@@ -2559,6 +2572,23 @@ this.google.maps.plugins.loader = (function (exports) {
25592572
url: this.url
25602573
};
25612574
}
2575+
}, {
2576+
key: "status",
2577+
get: function get() {
2578+
if (this.errors.length) {
2579+
return exports.LoaderStatus.FAILURE;
2580+
}
2581+
2582+
if (this.done) {
2583+
return exports.LoaderStatus.SUCCESS;
2584+
}
2585+
2586+
if (this.loading) {
2587+
return exports.LoaderStatus.LOADING;
2588+
}
2589+
2590+
return exports.LoaderStatus.INITIALIZED;
2591+
}
25622592
}, {
25632593
key: "failed",
25642594
get: function get() {

‎dist/index.esm.js

Lines changed: 23 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.esm.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.umd.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.umd.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎enums/LoaderStatus.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LoaderStatus | @googlemaps/js-api-loader</title><meta name="description" content="Documentation for @googlemaps/js-api-loader"/><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">@googlemaps/js-api-loader</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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@googlemaps/js-api-loader</a></li><li><a href="LoaderStatus.html">LoaderStatus</a></li></ul><h1>Enumeration LoaderStatus</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2+
<p>The status of the <a href="../classes/Loader.html">Loader</a>.</p>
3+
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#FAILURE" class="tsd-kind-icon">FAILURE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#INITIALIZED" class="tsd-kind-icon">INITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#LOADING" class="tsd-kind-icon">LOADING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#SUCCESS" class="tsd-kind-icon">SUCCESS</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FAILURE" class="tsd-anchor"></a><h3>FAILURE</h3><div class="tsd-signature tsd-kind-icon">FAILURE<span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/googlemaps/js-api-loader/blob/0402c78/src/index.ts#L175">index.ts:175</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="INITIALIZED" class="tsd-anchor"></a><h3>INITIALIZED</h3><div class="tsd-signature tsd-kind-icon">INITIALIZED<span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/googlemaps/js-api-loader/blob/0402c78/src/index.ts#L172">index.ts:172</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LOADING" class="tsd-anchor"></a><h3>LOADING</h3><div class="tsd-signature tsd-kind-icon">LOADING<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/googlemaps/js-api-loader/blob/0402c78/src/index.ts#L173">index.ts:173</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SUCCESS" class="tsd-anchor"></a><h3>SUCCESS</h3><div class="tsd-signature tsd-kind-icon">SUCCESS<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/googlemaps/js-api-loader/blob/0402c78/src/index.ts#L174">index.ts:174</a></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="LoaderStatus.html" class="tsd-kind-icon">Loader<wbr/>Status</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#FAILURE" class="tsd-kind-icon">FAILURE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#INITIALIZED" class="tsd-kind-icon">INITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#LOADING" class="tsd-kind-icon">LOADING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LoaderStatus.html#SUCCESS" class="tsd-kind-icon">SUCCESS</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><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="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>

0 commit comments

Comments
 (0)