readme/doc

farfromrefug · farfromrefug · commit b81824dc6438 · 2023-04-30T15:00:55.000+02:00
diff --git a/README.md b/README.md
@@ -1,29 +1,71 @@
-<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
-[](#nativescript-akylas-sqlite)
+<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
+<!--  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      DO NOT EDIT THIS READEME DIRECTLY! Edit "bluesprint.md" instead.
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<h1 align="center">@nativescript-community/sqlite</h1>
+<p align="center">
+		<a href="https://npmcharts.com/compare/@nativescript-community/sqlite?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/sqlite.svg" height="20"/></a>
+<a href="https://www.npmjs.com/package/@nativescript-community/sqlite"><img alt="NPM Version" src="https://img.shields.io/npm/v/@nativescript-community/sqlite.svg" height="20"/></a>
+	</p>
+
+<p align="center">
+  <b>SQLite for Nativescript</b></br>
+  <sub><sub>
+</p>
+
+<br />
+
+
+
+[](#table-of-contents)
+
 
-# Nativescript: Akylas Sqlite
+[](#table-of-contents)
+
+## Table of Contents
 
-[![npm](https://img.shields.io/npm/v/@nativescript-community/sqlite.svg)](https://www.npmjs.com/package/@nativescript-community/sqlite)
-[![npm](https://img.shields.io/npm/dt/@nativescript-community/sqlite.svg?label=npm%20downloads)](https://www.npmjs.com/package/@nativescript-community/sqlite)
+* [Installation](#installation)
+* [Usage](#usage)
 
 
+[](#installation)
+
+
 [](#installation)
 
 ## Installation
+Run the following command from the root of your project:
 
-```
-ns plugin add @nativescript-community/sqlite
-```
+`ns plugin add @nativescript-community/sqlite`
 
 
+[](#usage)
+
+
 [](#usage)
 
 ## Usage
 
 You should take care of wrapping sqlite calls to your preferred async option (promises, observables, async/await). And catch any exceptions thrown.
 
 ```typescript
-import { openOrCreate, deleteDatabase } from "nativescript-akylas-sqlite";
+import { openOrCreate, deleteDatabase } from "@nativescript-community/sqlite";
 
 const sqlite = openOrCreate("path/to/db");
 sqlite.execute("CREATE TABLE names (id INT, name TEXT)");
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,10 +1,10 @@
 :root {
-    --light-hl-0: #001080;
-    --dark-hl-0: #9CDCFE;
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #AF00DB;
-    --dark-hl-2: #C586C0;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
     --light-hl-3: #A31515;
     --dark-hl-3: #CE9178;
     --light-hl-4: #0000FF;
diff --git a/docs/index.html b/docs/index.html
@@ -12,28 +12,67 @@
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <h2>SQLite for Nativescript</h2></div>
-<div class="tsd-panel tsd-typography"><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
-<p><a href="#nativescript-akylas-sqlite"></a></p>
+<div class="tsd-panel tsd-typography"><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
+<!--  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      DO NOT EDIT THIS READEME DIRECTLY! Edit "bluesprint.md" instead.
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<h1 align="center">@nativescript-community/sqlite</h1>
+<p align="center">
+        <a href="https://npmcharts.com/compare/@nativescript-community/sqlite?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/sqlite.svg" height="20"/></a>
+<a href="https://www.npmjs.com/package/@nativescript-community/sqlite"><img alt="NPM Version" src="https://img.shields.io/npm/v/@nativescript-community/sqlite.svg" height="20"/></a>
+    </p>
 
-<a href="#nativescript-akylas-sqlite" id="nativescript-akylas-sqlite" style="color: inherit; text-decoration: none;">
-  <h1>Nativescript: Akylas Sqlite</h1>
+<p align="center">
+  <b>SQLite for Nativescript</b></br>
+  <sub><sub>
+</p>
+
+<br />
+
+
+
+<p><a href="#table-of-contents"></a></p>
+<p><a href="#table-of-contents"></a></p>
+
+<a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;">
+  <h2>Table of Contents</h2>
 </a>
-<p><a href="https://www.npmjs.com/package/@nativescript-community/sqlite"><img src="https://img.shields.io/npm/v/@nativescript-community/sqlite.svg" alt="npm"></a>
-<a href="https://www.npmjs.com/package/@nativescript-community/sqlite"><img src="https://img.shields.io/npm/dt/@nativescript-community/sqlite.svg?label=npm%20downloads" alt="npm"></a></p>
+<ul>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#usage">Usage</a></li>
+</ul>
+<p><a href="#installation"></a></p>
 <p><a href="#installation"></a></p>
 
 <a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
   <h2>Installation</h2>
 </a>
-<pre><code><span class="hl-0">ns</span><span class="hl-1"> </span><span class="hl-0">plugin</span><span class="hl-1"> </span><span class="hl-0">add</span><span class="hl-1"> @</span><span class="hl-0">nativescript</span><span class="hl-1">-</span><span class="hl-0">community</span><span class="hl-1">/</span><span class="hl-0">sqlite</span>
-</code></pre>
+<p>Run the following command from the root of your project:</p>
+<p><code>ns plugin add @nativescript-community/sqlite</code></p>
+<p><a href="#usage"></a></p>
 <p><a href="#usage"></a></p>
 
 <a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
   <h2>Usage</h2>
 </a>
 <p>You should take care of wrapping sqlite calls to your preferred async option (promises, observables, async/await). And catch any exceptions thrown.</p>
-<pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">openOrCreate</span><span class="hl-1">, </span><span class="hl-0">deleteDatabase</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;nativescript-akylas-sqlite&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">sqlite</span><span class="hl-1"> = </span><span class="hl-6">openOrCreate</span><span class="hl-1">(</span><span class="hl-3">&quot;path/to/db&quot;</span><span class="hl-1">);</span><br/><span class="hl-0">sqlite</span><span class="hl-1">.</span><span class="hl-6">execute</span><span class="hl-1">(</span><span class="hl-3">&quot;CREATE TABLE names (id INT, name TEXT)&quot;</span><span class="hl-1">);</span><br/><span class="hl-0">sqlite</span><span class="hl-1">.</span><span class="hl-6">transaction</span><span class="hl-1">(</span><span class="hl-0">cancelTransaction</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-7">// Calling cancelTransaction will rollback all changes made to db</span><br/><span class="hl-1">    </span><span class="hl-0">names</span><span class="hl-1">.</span><span class="hl-6">forEach</span><span class="hl-1">((</span><span class="hl-0">name</span><span class="hl-1">, </span><span class="hl-0">id</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1">        </span><span class="hl-0">sqlite</span><span class="hl-1">.</span><span class="hl-6">execute</span><span class="hl-1">(</span><br/><span class="hl-1">            </span><span class="hl-3">&quot;INSERT INTO names (id, name) VALUES (?, ?)&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            [</span><span class="hl-0">id</span><span class="hl-1">, </span><span class="hl-0">name</span><span class="hl-1">]</span><br/><span class="hl-1">        )</span><br/><span class="hl-1">    );</span><br/><span class="hl-1">});</span>
+<pre><code class="language-typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">openOrCreate</span><span class="hl-1">, </span><span class="hl-2">deleteDatabase</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@nativescript-community/sqlite&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">sqlite</span><span class="hl-1"> = </span><span class="hl-6">openOrCreate</span><span class="hl-1">(</span><span class="hl-3">&quot;path/to/db&quot;</span><span class="hl-1">);</span><br/><span class="hl-2">sqlite</span><span class="hl-1">.</span><span class="hl-6">execute</span><span class="hl-1">(</span><span class="hl-3">&quot;CREATE TABLE names (id INT, name TEXT)&quot;</span><span class="hl-1">);</span><br/><span class="hl-2">sqlite</span><span class="hl-1">.</span><span class="hl-6">transaction</span><span class="hl-1">(</span><span class="hl-2">cancelTransaction</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-7">// Calling cancelTransaction will rollback all changes made to db</span><br/><span class="hl-1">    </span><span class="hl-2">names</span><span class="hl-1">.</span><span class="hl-6">forEach</span><span class="hl-1">((</span><span class="hl-2">name</span><span class="hl-1">, </span><span class="hl-2">id</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><br/><span class="hl-1">        </span><span class="hl-2">sqlite</span><span class="hl-1">.</span><span class="hl-6">execute</span><span class="hl-1">(</span><br/><span class="hl-1">            </span><span class="hl-3">&quot;INSERT INTO names (id, name) VALUES (?, ?)&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            [</span><span class="hl-2">id</span><span class="hl-1">, </span><span class="hl-2">name</span><span class="hl-1">]</span><br/><span class="hl-1">        )</span><br/><span class="hl-1">    );</span><br/><span class="hl-1">});</span>
 </code></pre>
 <p><a href="#demos-and-development"></a></p>
 
@@ -45,7 +84,7 @@ <h2>Demos and Development</h2>
   <h3>Repo Setup</h3>
 </a>
 <p>The repo uses submodules. If you did not clone with <code> --recursive</code> then you need to call</p>
-<pre><code><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-0">submodule</span><span class="hl-1"> </span><span class="hl-0">update</span><span class="hl-1"> --</span><span class="hl-0">init</span>
+<pre><code><span class="hl-2">git</span><span class="hl-1"> </span><span class="hl-2">submodule</span><span class="hl-1"> </span><span class="hl-2">update</span><span class="hl-1"> --</span><span class="hl-2">init</span>
 </code></pre>
 <p>The package manager used to install and link dependencies must be <code>pnpm</code> or <code>yarn</code>. <code>npm</code> wont work.</p>
 <p>To develop and test:
@@ -113,7 +152,7 @@ <h3>modifying submodules</h3>
 </a>
 <p>The repo uses https:// for submodules which means you won&#39;t be able to push directly into the submodules.
 One easy solution is t modify <code>~/.gitconfig</code> and add</p>
-<pre><code><span class="hl-1">[</span><span class="hl-0">url</span><span class="hl-1"> </span><span class="hl-3">&quot;ssh://git@github.com/&quot;</span><span class="hl-1">]</span><br/><span class="hl-1">    </span><span class="hl-0">pushInsteadOf</span><span class="hl-1"> = </span><span class="hl-8">https</span><span class="hl-1">:</span><span class="hl-7">//github.com/</span>
+<pre><code><span class="hl-1">[</span><span class="hl-2">url</span><span class="hl-1"> </span><span class="hl-3">&quot;ssh://git@github.com/&quot;</span><span class="hl-1">]</span><br/><span class="hl-1">    </span><span class="hl-2">pushInsteadOf</span><span class="hl-1"> = </span><span class="hl-8">https</span><span class="hl-1">:</span><span class="hl-7">//github.com/</span>
 </code></pre>
 <p><a href="#questions"></a></p>
 
