Skip to content

Commit a0e6e63

Browse files
soedirgosoedirgo
authored
Merge pull request #346 from supabase/chore/merge-master-to-rc
Chore/merge master to rc
2 parents 890c020 + 8636e0d commit a0e6e63

31 files changed

+8158
-10
lines changed

‎.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
node_modules
22
dist
3-
docs
3+
docs/v2
44
*.log
55

66
# nyc
77
coverage
88
.nyc_output
99

10-
.idea
10+
.idea

‎docs/v1/assets/css/main.css

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

‎docs/v1/assets/images/icons.png

9.39 KB
Loading

‎docs/v1/assets/images/[email protected]

27.5 KB
Loading

‎docs/v1/assets/images/widgets.png

480 Bytes
Loading

‎docs/v1/assets/images/[email protected]

855 Bytes
Loading

‎docs/v1/assets/js/main.js

Lines changed: 51 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/v1/assets/js/search.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"kinds":{"1":"Module","65536":"Type literal"},"rows":[{"id":0,"kind":65536,"name":"__type","url":"classes/_lib_types_.postgrestbuilder.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"lib/types\".PostgrestBuilder.headers"},{"id":1,"kind":65536,"name":"__type","url":"modules/_lib_types_.html#postgresterror.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"\"lib/types\".PostgrestError"},{"id":2,"kind":65536,"name":"__type","url":"classes/_lib_postgresttransformbuilder_.postgresttransformbuilder.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"lib/PostgrestTransformBuilder\".PostgrestTransformBuilder.headers"},{"id":3,"kind":65536,"name":"__type","url":"classes/_lib_postgrestfilterbuilder_.postgrestfilterbuilder.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"lib/PostgrestFilterBuilder\".PostgrestFilterBuilder.headers"},{"id":4,"kind":65536,"name":"__type","url":"classes/_lib_postgrestquerybuilder_.postgrestquerybuilder.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"lib/PostgrestQueryBuilder\".PostgrestQueryBuilder.headers"},{"id":5,"kind":65536,"name":"__type","url":"classes/_lib_postgrestrpcbuilder_.postgrestrpcbuilder.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"lib/PostgrestRpcBuilder\".PostgrestRpcBuilder.headers"},{"id":6,"kind":65536,"name":"__type","url":"classes/_postgrestclient_.postgrestclient.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"PostgrestClient\".PostgrestClient.headers"},{"id":7,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-module"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,1.823]],["parent/0",[1,1.693]],["name/1",[0,1.823]],["parent/1",[2,1.693]],["name/2",[0,1.823]],["parent/2",[3,1.693]],["name/3",[0,1.823]],["parent/3",[4,1.693]],["name/4",[0,1.823]],["parent/4",[5,1.693]],["name/5",[0,1.823]],["parent/5",[6,1.693]],["name/6",[0,1.823]],["parent/6",[7,1.693]],["name/7",[8,17.918]],["parent/7",[]]],"invertedIndex":[["__type",{"_index":0,"name":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{}},"parent":{}}],["index",{"_index":8,"name":{"7":{}},"parent":{}}],["lib/postgrestfilterbuilder\".postgrestfilterbuilder.headers",{"_index":4,"name":{},"parent":{"3":{}}}],["lib/postgrestquerybuilder\".postgrestquerybuilder.headers",{"_index":5,"name":{},"parent":{"4":{}}}],["lib/postgrestrpcbuilder\".postgrestrpcbuilder.headers",{"_index":6,"name":{},"parent":{"5":{}}}],["lib/postgresttransformbuilder\".postgresttransformbuilder.headers",{"_index":3,"name":{},"parent":{"2":{}}}],["lib/types\".postgrestbuilder.headers",{"_index":1,"name":{},"parent":{"0":{}}}],["lib/types\".postgresterror",{"_index":2,"name":{},"parent":{"1":{}}}],["postgrestclient\".postgrestclient.headers",{"_index":7,"name":{},"parent":{"6":{}}}]],"pipeline":[]}}

‎docs/v1/classes/_lib_postgrestfilterbuilder_.postgrestfilterbuilder.html

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

‎docs/v1/classes/_lib_postgrestquerybuilder_.postgrestquerybuilder.html

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

‎docs/v1/classes/_lib_postgrestrpcbuilder_.postgrestrpcbuilder.html

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

‎docs/v1/classes/_lib_postgresttransformbuilder_.postgresttransformbuilder.html

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

‎docs/v1/classes/_lib_types_.postgrestbuilder.html

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

‎docs/v1/classes/_postgrestclient_.postgrestclient.html

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

‎docs/v1/globals.html

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>@supabase/postgrest-js</title>
7+
<meta name="description" content="Documentation for @supabase/postgrest-js">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="index.html" class="title">@supabase/postgrest-js</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-externals" checked />
42+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43+
<input type="checkbox" id="tsd-filter-only-exported" />
44+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45+
</div>
46+
</div>
47+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48+
</div>
49+
</div>
50+
</div>
51+
</div>
52+
<div class="tsd-page-title">
53+
<div class="container">
54+
<ul class="tsd-breadcrumb">
55+
<li>
56+
<a href="globals.html">Globals</a>
57+
</li>
58+
</ul>
59+
<h1>@supabase/postgrest-js</h1>
60+
</div>
61+
</div>
62+
</header>
63+
<div class="container container-main">
64+
<div class="row">
65+
<div class="col-8 col-content">
66+
<section class="tsd-panel-group tsd-index-group">
67+
<h2>Index</h2>
68+
<section class="tsd-panel tsd-index-panel">
69+
<div class="tsd-index-content">
70+
<section class="tsd-index-section ">
71+
<h3>Modules</h3>
72+
<ul class="tsd-index-list">
73+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_postgrestclient_.html" class="tsd-kind-icon">&quot;<wbr>Postgrest<wbr>Client&quot;</a></li>
74+
<li class="tsd-kind-module"><a href="modules/_index_.html" class="tsd-kind-icon">&quot;index&quot;</a></li>
75+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_postgrestfilterbuilder_.html" class="tsd-kind-icon">&quot;lib/<wbr>Postgrest<wbr>Filter<wbr>Builder&quot;</a></li>
76+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_postgrestquerybuilder_.html" class="tsd-kind-icon">&quot;lib/<wbr>Postgrest<wbr>Query<wbr>Builder&quot;</a></li>
77+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_postgrestrpcbuilder_.html" class="tsd-kind-icon">&quot;lib/<wbr>Postgrest<wbr>Rpc<wbr>Builder&quot;</a></li>
78+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_postgresttransformbuilder_.html" class="tsd-kind-icon">&quot;lib/<wbr>Postgrest<wbr>Transform<wbr>Builder&quot;</a></li>
79+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_constants_.html" class="tsd-kind-icon">&quot;lib/constants&quot;</a></li>
80+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_types_.html" class="tsd-kind-icon">&quot;lib/types&quot;</a></li>
81+
<li class="tsd-kind-module tsd-is-external"><a href="modules/_lib_version_.html" class="tsd-kind-icon">&quot;lib/version&quot;</a></li>
82+
</ul>
83+
</section>
84+
</div>
85+
</section>
86+
</section>
87+
</div>
88+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
89+
<nav class="tsd-navigation primary">
90+
<ul>
91+
<li class="globals current ">
92+
<a href="globals.html"><em>Globals</em></a>
93+
</li>
94+
<li class="label tsd-is-external">
95+
<span>Externals</span>
96+
</li>
97+
<li class=" tsd-kind-module tsd-is-external">
98+
<a href="modules/_postgrestclient_.html">&quot;<wbr>Postgrest<wbr>Client&quot;</a>
99+
</li>
100+
<li class=" tsd-kind-module tsd-is-external">
101+
<a href="modules/_lib_postgrestfilterbuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Filter<wbr>Builder&quot;</a>
102+
</li>
103+
<li class=" tsd-kind-module tsd-is-external">
104+
<a href="modules/_lib_postgrestquerybuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Query<wbr>Builder&quot;</a>
105+
</li>
106+
<li class=" tsd-kind-module tsd-is-external">
107+
<a href="modules/_lib_postgrestrpcbuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Rpc<wbr>Builder&quot;</a>
108+
</li>
109+
<li class=" tsd-kind-module tsd-is-external">
110+
<a href="modules/_lib_postgresttransformbuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Transform<wbr>Builder&quot;</a>
111+
</li>
112+
<li class=" tsd-kind-module tsd-is-external">
113+
<a href="modules/_lib_constants_.html">&quot;lib/constants&quot;</a>
114+
</li>
115+
<li class=" tsd-kind-module tsd-is-external">
116+
<a href="modules/_lib_types_.html">&quot;lib/types&quot;</a>
117+
</li>
118+
<li class=" tsd-kind-module tsd-is-external">
119+
<a href="modules/_lib_version_.html">&quot;lib/version&quot;</a>
120+
</li>
121+
</ul>
122+
</nav>
123+
<nav class="tsd-navigation secondary menu-sticky">
124+
<ul class="before-current">
125+
</ul>
126+
</nav>
127+
</div>
128+
</div>
129+
</div>
130+
<footer class="with-border-bottom">
131+
<div class="container">
132+
<h2>Legend</h2>
133+
<div class="tsd-legend-group">
134+
</div>
135+
</div>
136+
</footer>
137+
<div class="container tsd-generator">
138+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
139+
</div>
140+
<div class="overlay"></div>
141+
<script src="assets/js/main.js"></script>
142+
</body>
143+
</html>

‎docs/v1/index.html

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>@supabase/postgrest-js</title>
7+
<meta name="description" content="Documentation for @supabase/postgrest-js">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="index.html" class="title">@supabase/postgrest-js</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-externals" checked />
42+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43+
<input type="checkbox" id="tsd-filter-only-exported" />
44+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45+
</div>
46+
</div>
47+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48+
</div>
49+
</div>
50+
</div>
51+
</div>
52+
<div class="tsd-page-title">
53+
<div class="container">
54+
<ul class="tsd-breadcrumb">
55+
<li>
56+
<a href="globals.html">Globals</a>
57+
</li>
58+
</ul>
59+
<h1>@supabase/postgrest-js</h1>
60+
</div>
61+
</div>
62+
</header>
63+
<div class="container container-main">
64+
<div class="row">
65+
<div class="col-8 col-content">
66+
<div class="tsd-panel tsd-typography">
67+
<a href="#postgrest-js" id="postgrest-js" style="color: inherit; text-decoration: none;">
68+
<h1><code>postgrest-js</code></h1>
69+
</a>
70+
<p><a href="https://github.com/supabase/postgrest-js/actions?query=branch%3Amaster"><img src="https://github.com/supabase/postgrest-js/workflows/CI/badge.svg" alt="Build"></a>
71+
<a href="https://www.npmjs.com/package/@supabase/postgrest-js"><img src="https://img.shields.io/npm/v/@supabase/postgrest-js" alt="Package"></a>
72+
<a href="#license"><img src="https://img.shields.io/npm/l/@supabase/postgrest-js" alt="License: MIT"></a></p>
73+
<p>Isomorphic JavaScript client for <a href="https://postgrest.org">PostgREST</a>. The goal of this library is to make an &quot;ORM-like&quot; restful interface.</p>
74+
<p>Full documentation can be found <a href="https://supabase.github.io/postgrest-js/">here</a>.</p>
75+
<a href="#quick-start" id="quick-start" style="color: inherit; text-decoration: none;">
76+
<h3>Quick start</h3>
77+
</a>
78+
<p>Install</p>
79+
<pre><code class="language-bash">npm install @supabase/postgrest-js</code></pre>
80+
<p>Usage</p>
81+
<pre><code class="language-js"><span class="hljs-keyword">import</span> { PostgrestClient } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;@supabase/postgrest-js&#x27;</span>
82+
83+
<span class="hljs-keyword">const</span> REST_URL = <span class="hljs-string">&#x27;http://localhost:3000&#x27;</span>
84+
<span class="hljs-keyword">const</span> postgrest = <span class="hljs-keyword">new</span> PostgrestClient(REST_URL)</code></pre>
85+
<ul>
86+
<li>select(): <a href="https://supabase.com/docs/reference/javascript/select">https://supabase.com/docs/reference/javascript/select</a></li>
87+
<li>insert(): <a href="https://supabase.com/docs/reference/javascript/insert">https://supabase.com/docs/reference/javascript/insert</a></li>
88+
<li>update(): <a href="https://supabase.com/docs/reference/javascript/update">https://supabase.com/docs/reference/javascript/update</a></li>
89+
<li>delete(): <a href="https://supabase.com/docs/reference/javascript/delete">https://supabase.com/docs/reference/javascript/delete</a></li>
90+
</ul>
91+
<a href="#custom-fetch-implementation" id="custom-fetch-implementation" style="color: inherit; text-decoration: none;">
92+
<h4>Custom <code>fetch</code> implementation</h4>
93+
</a>
94+
<p><code>postgrest-js</code> uses the <a href="https://www.npmjs.com/package/cross-fetch"><code>cross-fetch</code></a> library to make HTTP requests, but an alternative <code>fetch</code> implementation can be provided as an option. This is most useful in environments where <code>cross-fetch</code> is not compatible, for instance Cloudflare Workers:</p>
95+
<pre><code class="language-js"><span class="hljs-keyword">import</span> { PostgrestClient } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;@supabase/postgrest-js&#x27;</span>
96+
97+
<span class="hljs-keyword">const</span> REST_URL = <span class="hljs-string">&#x27;http://localhost:3000&#x27;</span>
98+
<span class="hljs-keyword">const</span> postgrest = <span class="hljs-keyword">new</span> PostgrestClient(REST_URL, {
99+
<span class="hljs-attr">fetch</span>: <span class="hljs-function">(<span class="hljs-params">...args</span>) =&gt;</span> fetch(...args),
100+
})</code></pre>
101+
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
102+
<h2>License</h2>
103+
</a>
104+
<p>This repo is licensed under MIT License.</p>
105+
<a href="#sponsors" id="sponsors" style="color: inherit; text-decoration: none;">
106+
<h2>Sponsors</h2>
107+
</a>
108+
<p>We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.</p>
109+
<p><a href="https://github.com/sponsors/supabase"><img src="https://user-images.githubusercontent.com/10214025/90518111-e74bbb00-e198-11ea-8f88-c9e3c1aa4b5b.png" alt="New Sponsor"></a></p>
110+
</div>
111+
</div>
112+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
113+
<nav class="tsd-navigation primary">
114+
<ul>
115+
<li class="globals ">
116+
<a href="globals.html"><em>Globals</em></a>
117+
</li>
118+
<li class="label tsd-is-external">
119+
<span>Externals</span>
120+
</li>
121+
<li class=" tsd-kind-module tsd-is-external">
122+
<a href="modules/_postgrestclient_.html">&quot;<wbr>Postgrest<wbr>Client&quot;</a>
123+
</li>
124+
<li class=" tsd-kind-module tsd-is-external">
125+
<a href="modules/_lib_postgrestfilterbuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Filter<wbr>Builder&quot;</a>
126+
</li>
127+
<li class=" tsd-kind-module tsd-is-external">
128+
<a href="modules/_lib_postgrestquerybuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Query<wbr>Builder&quot;</a>
129+
</li>
130+
<li class=" tsd-kind-module tsd-is-external">
131+
<a href="modules/_lib_postgrestrpcbuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Rpc<wbr>Builder&quot;</a>
132+
</li>
133+
<li class=" tsd-kind-module tsd-is-external">
134+
<a href="modules/_lib_postgresttransformbuilder_.html">&quot;lib/<wbr>Postgrest<wbr>Transform<wbr>Builder&quot;</a>
135+
</li>
136+
<li class=" tsd-kind-module tsd-is-external">
137+
<a href="modules/_lib_constants_.html">&quot;lib/constants&quot;</a>
138+
</li>
139+
<li class=" tsd-kind-module tsd-is-external">
140+
<a href="modules/_lib_types_.html">&quot;lib/types&quot;</a>
141+
</li>
142+
<li class=" tsd-kind-module tsd-is-external">
143+
<a href="modules/_lib_version_.html">&quot;lib/version&quot;</a>
144+
</li>
145+
</ul>
146+
</nav>
147+
<nav class="tsd-navigation secondary menu-sticky">
148+
<ul class="before-current">
149+
</ul>
150+
</nav>
151+
</div>
152+
</div>
153+
</div>
154+
<footer class="with-border-bottom">
155+
<div class="container">
156+
<h2>Legend</h2>
157+
<div class="tsd-legend-group">
158+
</div>
159+
</div>
160+
</footer>
161+
<div class="container tsd-generator">
162+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
163+
</div>
164+
<div class="overlay"></div>
165+
<script src="assets/js/main.js"></script>
166+
</body>
167+
</html>

0 commit comments

Comments
 (0)