Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs updated [ci-skip] #1941

Merged
merged 1 commit into from
Oct 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 41 additions & 4 deletions docs/amplify-theme/typedoc/partials/header.hbs
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@

<body>
{% include site-header.html %}
</body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell logo">
<a href="{{relativeURL "index.html"}}">
<img src="https://aws-amplify.github.io/images/layout/logo.png" style="width:38px; position: absolute; margin-top: 5px;">
<div style="margin-left: 45px; padding-top: 1px; position: absolute;">AWS Amplify API</div>
</a>
</div>
<div class="table-cell" style=""> <body>
<a href="/amplify-js/" style='background: #efefef; padding: 4px; border-radius: 20px; font-size: 14.5px; padding-left: 10px; padding-right: 10px;' for="tsd-filter-docs">AWS Amplify Home</a>
</div> </body>
<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>
{{#unless settings.excludeExternals}}
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
{{/unless}}
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="https://aws.github.io/aws-amplify/api#typedoc-main-index" class="tsd-widget menu no-caption">Menu</a>
</div>
</div>
</div>
</div>
</header>
2 changes: 1 addition & 1 deletion docs/api/assets/js/search.js

Large diffs are not rendered by default.

1,585 changes: 1,213 additions & 372 deletions docs/api/classes/abstractinteractionsprovider.html

Large diffs are not rendered by default.

1,575 changes: 1,208 additions & 367 deletions docs/api/classes/abstractpubsubprovider.html

Large diffs are not rendered by default.

1,987 changes: 1,414 additions & 573 deletions docs/api/classes/abstractxrprovider.html

Large diffs are not rendered by default.

1,640 changes: 1,244 additions & 396 deletions docs/api/classes/amplify.html

Large diffs are not rendered by default.

1,118 changes: 983 additions & 135 deletions docs/api/classes/amplifyangularmodule.html

Large diffs are not rendered by default.

1,118 changes: 983 additions & 135 deletions docs/api/classes/amplifyionicmodule.html

Large diffs are not rendered by default.

1,616 changes: 1,232 additions & 384 deletions docs/api/classes/amplifyservice.html

Large diffs are not rendered by default.

1,996 changes: 1,422 additions & 574 deletions docs/api/classes/analyticsclass.html

Large diffs are not rendered by default.

2,137 changes: 1,494 additions & 643 deletions docs/api/classes/apiclass.html

Large diffs are not rendered by default.

2,622 changes: 1,735 additions & 887 deletions docs/api/classes/asyncstoragecache.html

Large diffs are not rendered by default.

3,728 changes: 2,288 additions & 1,440 deletions docs/api/classes/authclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/authenticatorcomponent.html

Large diffs are not rendered by default.

1,440 changes: 1,144 additions & 296 deletions docs/api/classes/authenticatorcomponentcore.html

Large diffs are not rendered by default.

1,452 changes: 1,150 additions & 302 deletions docs/api/classes/authenticatorioniccomponent.html

Large diffs are not rendered by default.

1,980 changes: 1,400 additions & 580 deletions docs/api/classes/awsappsyncprovider.html

Large diffs are not rendered by default.

1,284 changes: 1,066 additions & 218 deletions docs/api/classes/awscredentials.html

Large diffs are not rendered by default.

2,011 changes: 1,412 additions & 599 deletions docs/api/classes/awsiotprovider.html

Large diffs are not rendered by default.

1,502 changes: 1,175 additions & 327 deletions docs/api/classes/awskinesisprovider.html

Large diffs are not rendered by default.

1,571 changes: 1,206 additions & 365 deletions docs/api/classes/awslexprovider.html

Large diffs are not rendered by default.

1,512 changes: 1,180 additions & 332 deletions docs/api/classes/awspinpointprovider.html

Large diffs are not rendered by default.

1,988 changes: 1,418 additions & 570 deletions docs/api/classes/browserstoragecache.html

Large diffs are not rendered by default.

1,872 changes: 1,360 additions & 512 deletions docs/api/classes/cachelist.html

Large diffs are not rendered by default.

1,354 changes: 1,101 additions & 253 deletions docs/api/classes/cacheobject.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/chatbotclass.html

Large diffs are not rendered by default.

1,508 changes: 1,178 additions & 330 deletions docs/api/classes/chatbotcomponent.html

Large diffs are not rendered by default.

1,836 changes: 1,316 additions & 520 deletions docs/api/classes/chatbotcomponentcore.html

Large diffs are not rendered by default.

1,872 changes: 1,334 additions & 538 deletions docs/api/classes/chatbotcomponentionic.html

Large diffs are not rendered by default.

1,252 changes: 1,050 additions & 202 deletions docs/api/classes/clientdevice.html

Large diffs are not rendered by default.

1,327 changes: 1,084 additions & 243 deletions docs/api/classes/clientsqueue.html

Large diffs are not rendered by default.

1,270 changes: 1,059 additions & 211 deletions docs/api/classes/componentmount.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/confirmsigninclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/confirmsignincomponent.html

Large diffs are not rendered by default.

1,662 changes: 1,242 additions & 420 deletions docs/api/classes/confirmsignincomponentcore.html

Large diffs are not rendered by default.

1,688 changes: 1,255 additions & 433 deletions docs/api/classes/confirmsignincomponentionic.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/confirmsignupclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/confirmsignupcomponent.html

Large diffs are not rendered by default.

1,774 changes: 1,298 additions & 476 deletions docs/api/classes/confirmsignupcomponentcore.html

Large diffs are not rendered by default.

1,806 changes: 1,314 additions & 492 deletions docs/api/classes/confirmsignupcomponentionic.html

Large diffs are not rendered by default.

1,996 changes: 1,422 additions & 574 deletions docs/api/classes/consolelogger.html

Large diffs are not rendered by default.

1,588 changes: 1,218 additions & 370 deletions docs/api/classes/credentials.html

Large diffs are not rendered by default.

1,292 changes: 1,070 additions & 222 deletions docs/api/classes/doublelinkednode.html

Large diffs are not rendered by default.

1,236 changes: 1,042 additions & 194 deletions docs/api/classes/dynamiccomponentdirective.html

Large diffs are not rendered by default.

1,272 changes: 1,060 additions & 212 deletions docs/api/classes/eventtracker.html

Large diffs are not rendered by default.

1,278 changes: 1,063 additions & 215 deletions docs/api/classes/facebookoauth.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/forgotpasswordclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/forgotpasswordcomponent.html

Large diffs are not rendered by default.

1,868 changes: 1,345 additions & 523 deletions docs/api/classes/forgotpasswordcomponentcore.html

Large diffs are not rendered by default.

1,906 changes: 1,364 additions & 542 deletions docs/api/classes/forgotpasswordcomponentionic.html

Large diffs are not rendered by default.

1,189 changes: 1,012 additions & 177 deletions docs/api/classes/formcomponent.html

Large diffs are not rendered by default.

1,278 changes: 1,063 additions & 215 deletions docs/api/classes/googleoauth.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/greetingclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/greetingcomponent.html

Large diffs are not rendered by default.

1,452 changes: 1,150 additions & 302 deletions docs/api/classes/greetingcomponentcore.html

Large diffs are not rendered by default.

1,468 changes: 1,158 additions & 310 deletions docs/api/classes/greetingcomponentionic.html

Large diffs are not rendered by default.

1,528 changes: 1,188 additions & 340 deletions docs/api/classes/hubclass.html

Large diffs are not rendered by default.

2,202 changes: 1,525 additions & 677 deletions docs/api/classes/i18n.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/i18noptions.html

Large diffs are not rendered by default.

2,022 changes: 1,435 additions & 587 deletions docs/api/classes/inmemorycache.html

Large diffs are not rendered by default.

1,518 changes: 1,183 additions & 335 deletions docs/api/classes/interactions.html

Large diffs are not rendered by default.

1,580 changes: 1,214 additions & 366 deletions docs/api/classes/js.html

Large diffs are not rendered by default.

1,478 changes: 1,163 additions & 315 deletions docs/api/classes/memorystorage.html

Large diffs are not rendered by default.

1,486 changes: 1,167 additions & 319 deletions docs/api/classes/methodembed.html

Large diffs are not rendered by default.

1,962 changes: 1,391 additions & 571 deletions docs/api/classes/mqttoverwsprovider.html

Large diffs are not rendered by default.

1,272 changes: 1,060 additions & 212 deletions docs/api/classes/pageviewtracker.html

Large diffs are not rendered by default.

1,202 changes: 1,025 additions & 177 deletions docs/api/classes/parser.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/photopickerclass.html

Large diffs are not rendered by default.

1,536 changes: 1,192 additions & 344 deletions docs/api/classes/photopickercomponent.html

Large diffs are not rendered by default.

1,842 changes: 1,332 additions & 510 deletions docs/api/classes/photopickercomponentcore.html

Large diffs are not rendered by default.

1,908 changes: 1,365 additions & 543 deletions docs/api/classes/photopickerioniccomponent.html

Large diffs are not rendered by default.

1,512 changes: 1,180 additions & 332 deletions docs/api/classes/pubsub.html

Large diffs are not rendered by default.

1,798 changes: 1,323 additions & 475 deletions docs/api/classes/pushnotification.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/requirenewpasswordclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/requirenewpasswordcomponent.html

Large diffs are not rendered by default.

1,621 changes: 1,228 additions & 393 deletions docs/api/classes/requirenewpasswordcomponentcore.html

Large diffs are not rendered by default.

1,645 changes: 1,240 additions & 405 deletions docs/api/classes/requirenewpasswordcomponentionic.html

Large diffs are not rendered by default.

1,858 changes: 1,353 additions & 505 deletions docs/api/classes/restclient.html

Large diffs are not rendered by default.

1,328 changes: 1,088 additions & 240 deletions docs/api/classes/restclientoptions.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/s3albumclass.html

Large diffs are not rendered by default.

1,452 changes: 1,150 additions & 302 deletions docs/api/classes/s3albumcomponent.html

Large diffs are not rendered by default.

1,448 changes: 1,135 additions & 313 deletions docs/api/classes/s3albumcomponentcore.html

Large diffs are not rendered by default.

1,462 changes: 1,142 additions & 320 deletions docs/api/classes/s3albumcomponentionic.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/s3imageclass.html

Large diffs are not rendered by default.

1,452 changes: 1,150 additions & 302 deletions docs/api/classes/s3imagecomponent.html

Large diffs are not rendered by default.

1,438 changes: 1,130 additions & 308 deletions docs/api/classes/s3imagecomponentcore.html

Large diffs are not rendered by default.

1,452 changes: 1,137 additions & 315 deletions docs/api/classes/s3imagecomponentionic.html

Large diffs are not rendered by default.

1,559 changes: 1,200 additions & 359 deletions docs/api/classes/serviceworkerclass.html

Large diffs are not rendered by default.

1,272 changes: 1,060 additions & 212 deletions docs/api/classes/sessiontracker.html

Large diffs are not rendered by default.

1,232 changes: 1,040 additions & 192 deletions docs/api/classes/signer.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/signinclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/signincomponent.html

Large diffs are not rendered by default.

1,733 changes: 1,284 additions & 449 deletions docs/api/classes/signincomponentcore.html

Large diffs are not rendered by default.

1,763 changes: 1,299 additions & 464 deletions docs/api/classes/signincomponentionic.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/classes/signupclass.html

Large diffs are not rendered by default.

1,432 changes: 1,140 additions & 292 deletions docs/api/classes/signupcomponent.html

Large diffs are not rendered by default.

2,013 changes: 1,424 additions & 589 deletions docs/api/classes/signupcomponentcore.html

Large diffs are not rendered by default.

2,059 changes: 1,447 additions & 612 deletions docs/api/classes/signupcomponentionic.html

Large diffs are not rendered by default.

1,508 changes: 1,178 additions & 330 deletions docs/api/classes/storagecache.html

Large diffs are not rendered by default.

1,724 changes: 1,286 additions & 438 deletions docs/api/classes/storageclass.html

Large diffs are not rendered by default.

1,286 changes: 1,067 additions & 219 deletions docs/api/classes/storagehelper.html

Large diffs are not rendered by default.

2,019 changes: 1,430 additions & 589 deletions docs/api/classes/sumerianprovider.html

Large diffs are not rendered by default.

2,000 changes: 1,424 additions & 576 deletions docs/api/classes/xr.html

Large diffs are not rendered by default.

1,303 changes: 1,075 additions & 228 deletions docs/api/classes/xrerror.html

Large diffs are not rendered by default.

1,243 changes: 1,045 additions & 198 deletions docs/api/classes/xrnodomelement.html

Large diffs are not rendered by default.

1,243 changes: 1,045 additions & 198 deletions docs/api/classes/xrnosceneconfigurederror.html

Large diffs are not rendered by default.

1,243 changes: 1,045 additions & 198 deletions docs/api/classes/xrprovidernotconfigured.html

Large diffs are not rendered by default.

1,243 changes: 1,045 additions & 198 deletions docs/api/classes/xrsceneloadfailure.html

Large diffs are not rendered by default.

1,243 changes: 1,045 additions & 198 deletions docs/api/classes/xrscenenotfounderror.html

Large diffs are not rendered by default.

1,243 changes: 1,045 additions & 198 deletions docs/api/classes/xrscenenotloadederror.html

Large diffs are not rendered by default.

8,008 changes: 4,566 additions & 3,442 deletions docs/api/globals.html

Large diffs are not rendered by default.

5,643 changes: 4,645 additions & 998 deletions docs/api/index.html

Large diffs are not rendered by default.

1,328 changes: 1,088 additions & 240 deletions docs/api/interfaces/amplifyconfig.html

Large diffs are not rendered by default.

1,304 changes: 1,076 additions & 228 deletions docs/api/interfaces/analyticsoptions.html

Large diffs are not rendered by default.

1,334 changes: 1,091 additions & 243 deletions docs/api/interfaces/analyticsprovider.html

Large diffs are not rendered by default.

1,234 changes: 1,041 additions & 193 deletions docs/api/interfaces/apioptions.html

Large diffs are not rendered by default.

1,272 changes: 1,060 additions & 212 deletions docs/api/interfaces/authcache.html

Large diffs are not rendered by default.

1,472 changes: 1,160 additions & 312 deletions docs/api/interfaces/authoptions.html

Large diffs are not rendered by default.

1,206 changes: 1,027 additions & 179 deletions docs/api/interfaces/authstate.html

Large diffs are not rendered by default.

1,446 changes: 1,147 additions & 299 deletions docs/api/interfaces/cacheconfig.html

Large diffs are not rendered by default.

1,374 changes: 1,111 additions & 263 deletions docs/api/interfaces/cacheitem.html

Large diffs are not rendered by default.

1,234 changes: 1,041 additions & 193 deletions docs/api/interfaces/cacheitemoptions.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/interfaces/confirmsignupoptions.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/eventattributes.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/eventmetrics.html

Large diffs are not rendered by default.

1,290 changes: 1,069 additions & 221 deletions docs/api/interfaces/eventtrackopts.html

Large diffs are not rendered by default.

1,248 changes: 1,048 additions & 200 deletions docs/api/interfaces/federatedresponse.html

Large diffs are not rendered by default.

1,220 changes: 1,034 additions & 186 deletions docs/api/interfaces/federateduser.html

Large diffs are not rendered by default.

1,206 changes: 1,027 additions & 179 deletions docs/api/interfaces/graphqloptions.html

Large diffs are not rendered by default.

1,248 changes: 1,048 additions & 200 deletions docs/api/interfaces/graphqlresult.html

Large diffs are not rendered by default.

1,644 changes: 1,246 additions & 398 deletions docs/api/interfaces/icache.html

Large diffs are not rendered by default.

1,300 changes: 1,074 additions & 226 deletions docs/api/interfaces/icredentials.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/interactionsoptions.html

Large diffs are not rendered by default.

1,422 changes: 1,135 additions & 287 deletions docs/api/interfaces/interactionsprovider.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/interactionsproviders.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/interactionsresponse.html

Large diffs are not rendered by default.

1,364 changes: 1,106 additions & 258 deletions docs/api/interfaces/logger.html

Large diffs are not rendered by default.

1,220 changes: 1,034 additions & 186 deletions docs/api/interfaces/mfarequireddetails.html

Large diffs are not rendered by default.

1,208 changes: 1,028 additions & 180 deletions docs/api/interfaces/mqttprovidertoptions.html

Large diffs are not rendered by default.

1,318 changes: 1,083 additions & 235 deletions docs/api/interfaces/oauth.html

Large diffs are not rendered by default.

1,318 changes: 1,083 additions & 235 deletions docs/api/interfaces/pageviewtrackopts.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/provideroptions.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/providertoptions.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/pubsuboptions.html

Large diffs are not rendered by default.

1,400 changes: 1,124 additions & 276 deletions docs/api/interfaces/pubsubprovider.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/sceneoptions.html

Large diffs are not rendered by default.

1,234 changes: 1,041 additions & 193 deletions docs/api/interfaces/sessiontrackopts.html

Large diffs are not rendered by default.

1,178 changes: 1,013 additions & 165 deletions docs/api/interfaces/signoutopts.html

Large diffs are not rendered by default.

1,276 changes: 1,062 additions & 214 deletions docs/api/interfaces/signupparams.html

Large diffs are not rendered by default.

1,276 changes: 1,062 additions & 214 deletions docs/api/interfaces/storageoptions.html

Large diffs are not rendered by default.

1,126 changes: 987 additions & 139 deletions docs/api/interfaces/xroptions.html

Large diffs are not rendered by default.

1,862 changes: 1,355 additions & 507 deletions docs/api/interfaces/xrprovider.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"cypress": "lerna exec yarn cypress",
"cypress:open": "lerna exec yarn cypress:open",
"coverage": "codecov || exit 0",
"docs": "typedoc packages/**/src --name amplify-js --hideGenerator --excludePrivate --ignoreCompilerErrors --mode file --out docs/api",
"docs": "typedoc packages/**/src --name amplify-js --hideGenerator --excludePrivate --ignoreCompilerErrors --mode file --out docs/api --theme docs/amplify-theme/typedoc/",
"build": "lerna exec yarn build",
"clean": "lerna run -- clean",
"format": "lerna run -- format",
Expand Down