Skip to content
This repository was archived by the owner on Mar 18, 2021. It is now read-only.

Commit 799427e

Browse files
Added missing doc file
1 parent 865eca3 commit 799427e

File tree

1 file changed

+142
-0
lines changed

1 file changed

+142
-0
lines changed

doc/api/monadart/Router/basePath.html

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<title>basePath property - Router class - monadart library - Dart API</title>
8+
<!-- required because all the links are pseudo-absolute -->
9+
<base href="../..">
10+
11+
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400' rel='stylesheet' type='text/css'>
12+
<link rel="stylesheet" href="static-assets/prettify.css">
13+
<link rel="stylesheet" href="static-assets/css/bootstrap.min.css">
14+
<link rel="stylesheet" href="static-assets/styles.css">
15+
16+
<meta name="description" content="API docs for the basePath property from the Router class, for the Dart programming language.">
17+
<link rel="icon" href="static-assets/favicon.png">
18+
19+
<!-- Do not remove placeholder -->
20+
<!-- Header Placeholder -->
21+
</head>
22+
23+
<body>
24+
25+
<div id="overlay-under-drawer"></div>
26+
27+
<header class="container-fluid" id="title">
28+
<nav class="navbar navbar-fixed-top">
29+
<div class="container">
30+
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
31+
<ol class="breadcrumbs gt-separated hidden-xs">
32+
<li><a href="index.html">monadart</a></li>
33+
<li><a href="monadart/monadart-library.html">monadart</a></li>
34+
<li><a href="monadart/Router-class.html">Router</a></li>
35+
<li class="self-crumb">basePath</li>
36+
</ol>
37+
<div class="self-name">basePath</div>
38+
</div>
39+
</nav>
40+
<div class="container masthead">
41+
<ol class="breadcrumbs gt-separated visible-xs">
42+
<li><a href="index.html">monadart</a></li>
43+
<li><a href="monadart/monadart-library.html">monadart</a></li>
44+
<li><a href="monadart/Router-class.html">Router</a></li>
45+
<li class="self-crumb">basePath</li>
46+
</ol>
47+
<div class="title-description">
48+
<h1 class="title">
49+
<div class="kind">property</div> basePath
50+
</h1>
51+
<!-- p class="subtitle">
52+
A string to be prepended to the beginning of every route this <code class="prettyprint lang-dart">Router</code> manages.
53+
</p -->
54+
</div>
55+
<ul class="subnav">
56+
</ul>
57+
</div>
58+
</header>
59+
60+
<div class="container body">
61+
62+
<div class="col-xs-6 col-sm-3 sidebar sidebar-offcanvas-left">
63+
<h5><a href="index.html">monadart</a></h5>
64+
<h5><a href="monadart/monadart-library.html">monadart</a></h5>
65+
<h5><a href="monadart/Router-class.html">Router</a></h5>
66+
67+
<ol>
68+
69+
70+
71+
<li class="section-title"><a href="monadart/Router-class.html#instance-properties">Properties</a></li>
72+
<li><a href="monadart/Router/basePath.html">basePath</a>
73+
</li>
74+
<li><a href="monadart/Router/unhandledRequestHandler.html">unhandledRequestHandler</a>
75+
</li>
76+
77+
<li class="section-title"><a href="monadart/Router-class.html#constructors">Constructors</a></li>
78+
<li><a href="monadart/Router/Router.html">Router</a></li>
79+
80+
81+
<li class="section-title"><a href="monadart/Router-class.html#methods">Methods</a></li>
82+
<li><a href="monadart/Router/addRoute.html">addRoute</a>
83+
</li>
84+
<li><a href="monadart/Router/routeRequest.html">routeRequest</a>
85+
</li>
86+
</ol>
87+
88+
</div><!--/.sidebar-offcanvas-->
89+
90+
<div class="col-xs-12 col-sm-9 col-md-6 main-content">
91+
92+
<section class="multi-line-signature">
93+
<span class="returntype">String</span>
94+
<span class="name ">basePath</span>
95+
<div class="readable-writable">
96+
read / write
97+
</div>
98+
</section>
99+
100+
<section class="desc markdown">
101+
102+
<p>A string to be prepended to the beginning of every route this <code class="prettyprint lang-dart">Router</code> manages.</p>
103+
<p>For example, if this <code class="prettyprint lang-dart">Router</code>'s base route is "/api" and the routes "/users/"
104+
and "/posts" are added, the actual routes will be "/api/users" and "/api/posts".
105+
This property MUST be set prior to adding routes, an exception will be thrown
106+
otherwise.</p>
107+
108+
</section>
109+
110+
</div> <!-- /.main-content -->
111+
112+
</div> <!-- container -->
113+
114+
<footer>
115+
<div class="container-fluid">
116+
<div class="container">
117+
<p class="text-center">
118+
<span class="no-break">
119+
monadart 0.0.1 api docs
120+
</span>
121+
&bull;
122+
<span class="copyright no-break">
123+
<a href="https://www.dartlang.org">
124+
<img src="static-assets/favicon.png" alt="Dart" title="Dart"width="16" height="16">
125+
</a>
126+
</span>
127+
&bull;
128+
<span class="copyright no-break">
129+
<a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
130+
</span>
131+
</p>
132+
</div>
133+
</div>
134+
</footer>
135+
136+
<script src="static-assets/prettify.js"></script>
137+
<script src="static-assets/script.js"></script>
138+
<!-- Do not remove placeholder -->
139+
<!-- Footer Placeholder -->
140+
</body>
141+
142+
</html>

0 commit comments

Comments
 (0)