From 70fad8a9ed26b399f63dfa89dba7abf72441a338 Mon Sep 17 00:00:00 2001 From: Aroop Roelofs Date: Wed, 18 Sep 2024 17:13:40 +0200 Subject: [PATCH] Update docs --- deno.lock | 4 ++ docs/search_index.js | 2 +- docs/~/Controller.html | 12 +++--- docs/~/Queue.html | 4 +- docs/~/Time.html | 4 +- docs/~/TimeString.html | 70 ++++++++++++++++++++++++++++++++++- docs/~/TimeStringSeconds.html | 70 ++++++++++++++++++++++++++++++++++- docs/~/Websocket.html | 8 ++-- 8 files changed, 155 insertions(+), 19 deletions(-) diff --git a/deno.lock b/deno.lock index fc7368e9..a187316c 100644 --- a/deno.lock +++ b/deno.lock @@ -5,6 +5,10 @@ "https://cdn.deno.land/std/versions/0.77.0/raw/datetime/mod.ts": "5d31444e61524f399ac17aa75401b7e47a7b2f6ccaa36575416a1253a8f61afa", "https://cdn.deno.land/std/versions/0.77.0/raw/datetime/tokenizer.ts": "ae21a459f2f017ac81b1b49caa81174b6b8ab8a4d8d82195dcf25bb67b565c71", "https://deno.land/std@0.117.0/fmt/colors.ts": "8368ddf2d48dfe413ffd04cdbb7ae6a1009cf0dccc9c7ff1d76259d9c61a0621", + "https://deno.land/std@0.152.0/fmt/colors.ts": "6f9340b7fb8cc25a993a99e5efc56fe81bb5af284ff412129dd06df06f53c0b4", + "https://deno.land/std@0.152.0/testing/_diff.ts": "029a00560b0d534bc0046f1bce4bd36b3b41ada3f2a3178c85686eb2ff5f1413", + "https://deno.land/std@0.152.0/testing/_format.ts": "0d8dc79eab15b67cdc532826213bbe05bccfd276ca473a50a3fc7bbfb7260642", + "https://deno.land/std@0.152.0/testing/asserts.ts": "093735c88f52bbead7f60a1f7a97a2ce4df3c2d5fab00a46956f20b4a5793ccd", "https://deno.land/x/croner@5.3.4/src/croner.js": "a7e06cd5c262c60bc9736d735eb65ae2e401eed3d965c467087a5a575abd8ec2", "https://deno.land/x/croner@5.3.4/src/date.js": "e5bfdf17750207a00e1399c50bda7be8746429619c9f2fc0679c678aed22febc", "https://deno.land/x/croner@5.3.4/src/helpers/minitz.js": "8b3824fadd0130b4faf38335a064febdf77c5582dcaa06f443b901e9b8233130", diff --git a/docs/search_index.js b/docs/search_index.js index fe6ce6ac..87e79a01 100644 --- a/docs/search_index.js +++ b/docs/search_index.js @@ -1,3 +1,3 @@ (function () { - window.DENO_DOC_SEARCH_INDEX = {"nodes":[{"kind":["enum"],"name":"Algorithms","file":".","location":{"filename":"","line":7,"col":0,"byteIndex":229},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Authenticator","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":95},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Cache","file":".","location":{"filename":"","line":10,"col":0,"byteIndex":222},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"CheckSource","file":".","location":{"filename":"","line":38,"col":0,"byteIndex":1093},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Configure","file":".","location":{"filename":"","line":9,"col":0,"byteIndex":233},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Controller","file":".","location":{"filename":"","line":15,"col":0,"byteIndex":574},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"CouchDB","file":".","location":{"filename":"","line":21,"col":0,"byteIndex":355},"declarationKind":"export","deprecated":false},{"kind":["function","namespace"],"name":"Cron","file":".","location":{"filename":"","line":56,"col":0,"byteIndex":2427},"declarationKind":"export","deprecated":false},{"kind":["variable"],"name":"Cron.Cron","file":".","location":{"filename":"","line":325,"col":5,"byteIndex":9058},"declarationKind":"declare","deprecated":false},{"kind":["variable"],"name":"DEFAULT_OPTS","file":".","location":{"filename":"","line":52,"col":13,"byteIndex":1435},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Druid","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["enum"],"name":"ErrorCodes","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Events","file":".","location":{"filename":"","line":8,"col":0,"byteIndex":102},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"ExclusionConfig","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":94},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"File","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Folder","file":".","location":{"filename":"","line":3,"col":0,"byteIndex":47},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"GraphQL","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Hash","file":".","location":{"filename":"","line":50,"col":0,"byteIndex":1339},"declarationKind":"export","deprecated":false},{"kind":["variable"],"name":"INSECURE_ALGORITHMS","file":".","location":{"filename":"","line":41,"col":13,"byteIndex":1177},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Inflector","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":63},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"InfluxDB","file":".","location":{"filename":"","line":16,"col":0,"byteIndex":184},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Logger","file":".","location":{"filename":"","line":44,"col":0,"byteIndex":1500},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Loki","file":".","location":{"filename":"","line":9,"col":0,"byteIndex":179},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Ntfy","file":".","location":{"filename":"","line":3,"col":0,"byteIndex":48},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Nut","file":".","location":{"filename":"","line":8,"col":0,"byteIndex":152},"declarationKind":"export","deprecated":false},{"kind":["variable"],"name":"PASSWORD_DEFAULT","file":".","location":{"filename":"","line":8,"col":13,"byteIndex":247},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Password","file":".","location":{"filename":"","line":67,"col":0,"byteIndex":1718},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"PasswordOptions","file":".","location":{"filename":"","line":60,"col":0,"byteIndex":1549},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"QueryParameters","file":".","location":{"filename":"","line":7,"col":0,"byteIndex":118},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Queue","file":".","location":{"filename":"","line":20,"col":0,"byteIndex":333},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"RCON","file":".","location":{"filename":"","line":8,"col":0,"byteIndex":132},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Random","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Redis","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":148},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Request","file":".","location":{"filename":"","line":11,"col":0,"byteIndex":186},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"RequestParameters","file":".","location":{"filename":"","line":3,"col":0,"byteIndex":48},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Router","file":".","location":{"filename":"","line":20,"col":0,"byteIndex":762},"declarationKind":"export","deprecated":false},{"kind":["enum"],"name":"StatusCodes","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Text","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Time","file":".","location":{"filename":"","line":5,"col":0,"byteIndex":242},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"TimeString","file":".","location":{"filename":"","line":77,"col":0,"byteIndex":1556},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"TimeStringSeconds","file":".","location":{"filename":"","line":97,"col":0,"byteIndex":2157},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"ViewVariable","file":".","location":{"filename":"","line":11,"col":0,"byteIndex":499},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Webserver","file":".","location":{"filename":"","line":5,"col":0,"byteIndex":145},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Websocket","file":".","location":{"filename":"","line":7,"col":0,"byteIndex":289},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"raise","file":".","location":{"filename":"","line":38,"col":0,"byteIndex":927},"declarationKind":"export","deprecated":false}]}; + window.DENO_DOC_SEARCH_INDEX = {"nodes":[{"kind":["enum"],"name":"Algorithms","file":".","location":{"filename":"","line":7,"col":0,"byteIndex":229},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Authenticator","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":95},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Cache","file":".","location":{"filename":"","line":10,"col":0,"byteIndex":211},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"CheckSource","file":".","location":{"filename":"","line":38,"col":0,"byteIndex":1093},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Configure","file":".","location":{"filename":"","line":9,"col":0,"byteIndex":227},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Controller","file":".","location":{"filename":"","line":15,"col":0,"byteIndex":574},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"CouchDB","file":".","location":{"filename":"","line":21,"col":0,"byteIndex":355},"declarationKind":"export","deprecated":false},{"kind":["function","namespace"],"name":"Cron","file":".","location":{"filename":"","line":56,"col":0,"byteIndex":2427},"declarationKind":"export","deprecated":false},{"kind":["variable"],"name":"Cron.Cron","file":".","location":{"filename":"","line":325,"col":5,"byteIndex":9058},"declarationKind":"declare","deprecated":false},{"kind":["variable"],"name":"DEFAULT_OPTS","file":".","location":{"filename":"","line":52,"col":13,"byteIndex":1435},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Druid","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["enum"],"name":"ErrorCodes","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Events","file":".","location":{"filename":"","line":8,"col":0,"byteIndex":102},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"ExclusionConfig","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":94},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"File","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Folder","file":".","location":{"filename":"","line":3,"col":0,"byteIndex":47},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"GraphQL","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Hash","file":".","location":{"filename":"","line":50,"col":0,"byteIndex":1339},"declarationKind":"export","deprecated":false},{"kind":["variable"],"name":"INSECURE_ALGORITHMS","file":".","location":{"filename":"","line":41,"col":13,"byteIndex":1177},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Inflector","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":63},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"InfluxDB","file":".","location":{"filename":"","line":16,"col":0,"byteIndex":184},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Logger","file":".","location":{"filename":"","line":44,"col":0,"byteIndex":1500},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Loki","file":".","location":{"filename":"","line":9,"col":0,"byteIndex":179},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Ntfy","file":".","location":{"filename":"","line":3,"col":0,"byteIndex":48},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Nut","file":".","location":{"filename":"","line":8,"col":0,"byteIndex":152},"declarationKind":"export","deprecated":false},{"kind":["variable"],"name":"PASSWORD_DEFAULT","file":".","location":{"filename":"","line":8,"col":13,"byteIndex":247},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Password","file":".","location":{"filename":"","line":67,"col":0,"byteIndex":1718},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"PasswordOptions","file":".","location":{"filename":"","line":60,"col":0,"byteIndex":1549},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"QueryParameters","file":".","location":{"filename":"","line":7,"col":0,"byteIndex":118},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Queue","file":".","location":{"filename":"","line":20,"col":0,"byteIndex":333},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"RCON","file":".","location":{"filename":"","line":8,"col":0,"byteIndex":132},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Random","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Redis","file":".","location":{"filename":"","line":4,"col":0,"byteIndex":148},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Request","file":".","location":{"filename":"","line":11,"col":0,"byteIndex":186},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"RequestParameters","file":".","location":{"filename":"","line":3,"col":0,"byteIndex":48},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Router","file":".","location":{"filename":"","line":20,"col":0,"byteIndex":762},"declarationKind":"export","deprecated":false},{"kind":["enum"],"name":"StatusCodes","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Text","file":".","location":{"filename":"","line":1,"col":0,"byteIndex":0},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Time","file":".","location":{"filename":"","line":5,"col":0,"byteIndex":242},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"TimeString","file":".","location":{"filename":"","line":84,"col":0,"byteIndex":1726},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"TimeStringSeconds","file":".","location":{"filename":"","line":111,"col":0,"byteIndex":2499},"declarationKind":"export","deprecated":false},{"kind":["interface"],"name":"ViewVariable","file":".","location":{"filename":"","line":11,"col":0,"byteIndex":499},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Webserver","file":".","location":{"filename":"","line":5,"col":0,"byteIndex":145},"declarationKind":"export","deprecated":false},{"kind":["class"],"name":"Websocket","file":".","location":{"filename":"","line":7,"col":0,"byteIndex":289},"declarationKind":"export","deprecated":false},{"kind":["function"],"name":"raise","file":".","location":{"filename":"","line":38,"col":0,"byteIndex":927},"declarationKind":"export","deprecated":false}]}; })() \ No newline at end of file diff --git a/docs/~/Controller.html b/docs/~/Controller.html index 6b76f065..96b543ab 100644 --- a/docs/~/Controller.html +++ b/docs/~/Controller.html @@ -183,8 +183,8 @@

-
writeonly
-
deprecated
+
deprecated
+
writeonly
type -
private
-
readonly
+
readonly
+
private
_componentDir: string -
readonly
-
private
+
private
+
readonly
_templateDir: `./src/templates`
-
private
-
readonly
+
readonly
+
private
scheduler: Scheduler
-
private
-
readonly
+
readonly
+
private
time

Takes a time string and turns it into milliseconds

-
+
+
+ + + + + + + + + + +
+ +
▶

Example 1

+
 + 
import { TimeStringSeconds } from "https://deno.land/x/chomp/utility/time-string.ts";
+
+const milliseconds = TimeString`+1 minute`;
+
+
+
+
+
+
diff --git a/docs/~/TimeStringSeconds.html b/docs/~/TimeStringSeconds.html index 5cba3cb3..3c00a4e5 100644 --- a/docs/~/TimeStringSeconds.html +++ b/docs/~/TimeStringSeconds.html @@ -78,7 +78,73 @@

Takes a time string and turns it into round seconds

-
+
+
+

+ + + + + + + + + + +Examples

+ + + + + + + + + + +
+ +
▶

Example 1

+
 + 
import { TimeStringSeconds } from "https://deno.land/x/chomp/utility/time-string.ts";
+
+const seconds = TimeStringSeconds`+1 minute`;
+
+
+
+
+
+

Usage


-        
Document Navigation
+

Document Navigation

diff --git a/docs/~/Websocket.html b/docs/~/Websocket.html index 0c7f72d0..e6558519 100644 --- a/docs/~/Websocket.html +++ b/docs/~/Websocket.html @@ -183,8 +183,8 @@

-
private
-
readonly
+
readonly
+
private
authenticate: boolean
-
private
-
readonly
+
readonly
+
private
port: number