diff --git a/content/2.framework/2.genie.jl/3.API/GenieAuthentication/_dir.yml b/content/2.framework/2.genie.jl/3.API/GenieAuthentication/_dir.yml deleted file mode 100644 index ac45113..0000000 --- a/content/2.framework/2.genie.jl/3.API/GenieAuthentication/_dir.yml +++ /dev/null @@ -1 +0,0 @@ -title: GenieAuthentication diff --git a/content/2.framework/2.genie.jl/3.API/GenieAuthorisation/_dir.yml b/content/2.framework/2.genie.jl/3.API/GenieAuthorisation/_dir.yml deleted file mode 100644 index d8157c1..0000000 --- a/content/2.framework/2.genie.jl/3.API/GenieAuthorisation/_dir.yml +++ /dev/null @@ -1 +0,0 @@ -title: GenieAuthorisation diff --git a/content/2.framework/2.genie.jl/3.API/GenieCache/_dir.yml b/content/2.framework/2.genie.jl/3.API/GenieCache/_dir.yml deleted file mode 100644 index 8d1bd14..0000000 --- a/content/2.framework/2.genie.jl/3.API/GenieCache/_dir.yml +++ /dev/null @@ -1 +0,0 @@ -title: GenieCache diff --git a/content/2.framework/2.genie.jl/3.API/GenieDeploy/_dir.yml b/content/2.framework/2.genie.jl/3.API/GenieDeploy/_dir.yml deleted file mode 100644 index 2e1541d..0000000 --- a/content/2.framework/2.genie.jl/3.API/GenieDeploy/_dir.yml +++ /dev/null @@ -1 +0,0 @@ -title: GenieDeploy diff --git a/content/2.framework/2.genie.jl/3.API/GenieSession/_dir.yml b/content/2.framework/2.genie.jl/3.API/GenieSession/_dir.yml deleted file mode 100644 index 60ecc2d..0000000 --- a/content/2.framework/2.genie.jl/3.API/GenieSession/_dir.yml +++ /dev/null @@ -1 +0,0 @@ -title: GenieSession diff --git a/content/2.framework/2.genie.jl/3.API/_dir.yml b/content/2.framework/2.genie.jl/3.API/_dir.yml index 41cdb15..6bcb1f4 100644 --- a/content/2.framework/2.genie.jl/3.API/_dir.yml +++ b/content/2.framework/2.genie.jl/3.API/_dir.yml @@ -1 +1 @@ -title: "API" +title: API \ No newline at end of file diff --git a/content/2.framework/2.genie.jl/3.API/assets.md b/content/2.framework/2.genie.jl/3.API/assets.md index 6cce5b8..cd69ae8 100644 --- a/content/2.framework/2.genie.jl/3.API/assets.md +++ b/content/2.framework/2.genie.jl/3.API/assets.md @@ -62,7 +62,10 @@ Updates the assets configuration for the current package. :: -::alert{type="info"} Missing docstring for `assets_endpoint`. :: + +::alert{type="info"} +Missing docstring for `assets_endpoint`. +:: ::ApiCard{object="Genie.Assets.asset_file" category="Function"} @@ -121,7 +124,10 @@ Outputs the `channels.js` file included with the Genie package. :: -::alert{type="info"} Missing docstring for `channels_route`. :: + +::alert{type="info"} +Missing docstring for `channels_route`. +:: ::ApiCard{object="Genie.Assets.channels_script" category="Function"} @@ -136,7 +142,10 @@ Outputs the channels JavaScript content within `` tags, for :: -::alert{type="info"} Missing docstring for `channels_script_tag`. :: + +::alert{type="info"} +Missing docstring for `channels_script_tag`. +:: ::ApiCard{object="Genie.Assets.channels_subscribe" category="Function"} @@ -241,7 +250,10 @@ Path to a js asset. `file_name` should not include the extension. :: -::alert{type="info"} Missing docstring for `jsliteral`. :: + +::alert{type="info"} +Missing docstring for `jsliteral`. +:: ::ApiCard{object="Genie.Assets.js_settings" category="Function"} @@ -267,7 +279,10 @@ Outputs the webthreads.js file included with the Genie package :: -::alert{type="info"} Missing docstring for `webthreads_endpoint`. :: + +::alert{type="info"} +Missing docstring for `webthreads_endpoint`. +:: ::ApiCard{object="Genie.Assets.webthreads_push_pull" category="Function"} @@ -282,7 +297,10 @@ Registers push and pull routes for `channel`. :: -::alert{type="info"} Missing docstring for `webthreads_route`. :: + +::alert{type="info"} +Missing docstring for `webthreads_route`. +:: ::ApiCard{object="Genie.Assets.webthreads_script" category="Function"} @@ -297,7 +315,10 @@ Outputs the channels JavaScript content within `` tags, for :: -::alert{type="info"} Missing docstring for `webthreads_script_tag`. :: + +::alert{type="info"} +Missing docstring for `webthreads_script_tag`. +:: ::ApiCard{object="Genie.Assets.webthreads_subscribe" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/cookies.md b/content/2.framework/2.genie.jl/3.API/cookies.md index 9a7a9b2..8bb0f61 100644 --- a/content/2.framework/2.genie.jl/3.API/cookies.md +++ b/content/2.framework/2.genie.jl/3.API/cookies.md @@ -8,7 +8,7 @@ Dict([itr]) ``` -`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`]() and hashed with [`hash`](). +`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`](@ref) and hashed with [`hash`](@ref). Given a single iterable argument, constructs a [`Dict`](cookies.md#Base.Dict) whose key-value pairs are taken from 2-tuples `(key,value)` generated by the argument. diff --git a/content/2.framework/2.genie.jl/3.API/generator.md b/content/2.framework/2.genie.jl/3.API/generator.md index 65e8a23..4c14f7a 100644 --- a/content/2.framework/2.genie.jl/3.API/generator.md +++ b/content/2.framework/2.genie.jl/3.API/generator.md @@ -1,7 +1,10 @@ -::alert{type="info"} Missing docstring for `autoconfdb`. :: + +::alert{type="info"} +Missing docstring for `autoconfdb`. +:: ::ApiCard{object="Genie.Generator.autostart_app" category="Function"} @@ -16,7 +19,10 @@ If `autostart` is `true`, the newly generated Genie app will be automatically st :: -::alert{type="info"} Missing docstring for `binfolderpath`. :: + +::alert{type="info"} +Missing docstring for `binfolderpath`. +:: ::ApiCard{object="Genie.Generator.controller_file_name" category="Function"} @@ -31,7 +37,10 @@ Computes the controller file name based on the resource name. :: -::alert{type="info"} Missing docstring for `db_intializer`. :: + +::alert{type="info"} +Missing docstring for `db_intializer`. +:: ::ApiCard{object="Genie.Generator.db_support" category="Function"} @@ -79,11 +88,17 @@ Installs the application's dependencies using Julia's Pkg :: -::alert{type="info"} Missing docstring for `install_db_dependencies`. :: + +::alert{type="info"} +Missing docstring for `install_db_dependencies`. +:: -::alert{type="info"} Missing docstring for `install_searchlight_dependencies`. :: + +::alert{type="info"} +Missing docstring for `install_searchlight_dependencies`. +:: ::ApiCard{object="Genie.Generator.microstack_app" category="Function"} @@ -274,15 +289,24 @@ Creates a new Genie `Task` file. :: -::alert{type="info"} Missing docstring for `pkggenfile`. :: + +::alert{type="info"} +Missing docstring for `pkggenfile`. +:: + + +::alert{type="info"} +Missing docstring for `pkgproject`. +:: -::alert{type="info"} Missing docstring for `pkgproject`. :: -::alert{type="info"} Missing docstring for `post_create`. :: +::alert{type="info"} +Missing docstring for `post_create`. +:: ::ApiCard{object="Genie.Generator.remove_searchlight_initializer" category="Function"} @@ -319,7 +343,10 @@ Writes the file necessary to scaffold a minimal Genie app. :: -::alert{type="info"} Missing docstring for `set_files_mod`. :: + +::alert{type="info"} +Missing docstring for `set_files_mod`. +:: ::ApiCard{object="Genie.Generator.setup_resource_path" category="Function"} @@ -356,7 +383,10 @@ Creates the bin/server and bin/repl binaries for Windows :: -::alert{type="info"} Missing docstring for `validname`. :: + +::alert{type="info"} +Missing docstring for `validname`. +:: ::ApiCard{object="Genie.Generator.write_app_custom_files" category="Function"} @@ -371,7 +401,10 @@ Writes the Genie app main module file. :: -::alert{type="info"} Missing docstring for `write_db_config`. :: + +::alert{type="info"} +Missing docstring for `write_db_config`. +:: ::ApiCard{object="Genie.Generator.write_resource_file" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/genie.md b/content/2.framework/2.genie.jl/3.API/genie.md index 122056f..f3df111 100644 --- a/content/2.framework/2.genie.jl/3.API/genie.md +++ b/content/2.framework/2.genie.jl/3.API/genie.md @@ -90,7 +90,10 @@ julia> Genie.loadapp(".") :: -::alert{type="info"} Missing docstring for `isrunning`. :: + +::alert{type="info"} +Missing docstring for `isrunning`. +:: ::ApiCard{object="Genie.loadapp" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/headers.md b/content/2.framework/2.genie.jl/3.API/headers.md index 868da6a..37f1a4f 100644 --- a/content/2.framework/2.genie.jl/3.API/headers.md +++ b/content/2.framework/2.genie.jl/3.API/headers.md @@ -23,11 +23,17 @@ Makes request headers case insensitive. :: -::alert{type="info"} Missing docstring for `set_access_control_allow_headers!`. :: + +::alert{type="info"} +Missing docstring for `set_access_control_allow_headers!`. +:: -::alert{type="info"} Missing docstring for `set_access_control_allow_origin!`. :: + +::alert{type="info"} +Missing docstring for `set_access_control_allow_origin!`. +:: ::ApiCard{object="Genie.Headers.set_headers!" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/httputils.md b/content/2.framework/2.genie.jl/3.API/httputils.md index c08fd10..364d602 100644 --- a/content/2.framework/2.genie.jl/3.API/httputils.md +++ b/content/2.framework/2.genie.jl/3.API/httputils.md @@ -1,6 +1,9 @@ -::alert{type="info"} Missing docstring for `HTTPUtils.Dict`. :: + +::alert{type="info"} +Missing docstring for `HTTPUtils.Dict`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/input.md b/content/2.framework/2.genie.jl/3.API/input.md index 5eb779e..8aa8b84 100644 --- a/content/2.framework/2.genie.jl/3.API/input.md +++ b/content/2.framework/2.genie.jl/3.API/input.md @@ -12,46 +12,79 @@ Represents a file sent over HTTP :: -::alert{type="info"} Missing docstring for `HttpFormPart`. :: +::alert{type="info"} +Missing docstring for `HttpFormPart`. +:: + + + + +::alert{type="info"} +Missing docstring for `HttpInput`. +:: + + + + +::alert{type="info"} +Missing docstring for `all`. +:: -::alert{type="info"} Missing docstring for `HttpInput`. :: +::alert{type="info"} +Missing docstring for `files`. +:: -::alert{type="info"} Missing docstring for `all`. :: -::alert{type="info"} Missing docstring for `files`. :: +::alert{type="info"} +Missing docstring for `get_multiform_parts!`. +:: -::alert{type="info"} Missing docstring for `get_multiform_parts!`. :: +::alert{type="info"} +Missing docstring for `parse_seicolon_fields`. +:: -::alert{type="info"} Missing docstring for `parse_seicolon_fields`. :: +::alert{type="info"} +Missing docstring for `post`. +:: -::alert{type="info"} Missing docstring for `post`. :: -::alert{type="info"} Missing docstring for `post_from_request!`. :: +::alert{type="info"} +Missing docstring for `post_from_request!`. +:: -::alert{type="info"} Missing docstring for `parse_quoted_params`. :: +::alert{type="info"} +Missing docstring for `parse_quoted_params`. +:: -::alert{type="info"} Missing docstring for `post_multipart!`. :: + + +::alert{type="info"} +Missing docstring for `post_multipart!`. +:: -::alert{type="info"} Missing docstring for `post_url_encoded!`. :: + +::alert{type="info"} +Missing docstring for `post_url_encoded!`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/loader.md b/content/2.framework/2.genie.jl/3.API/loader.md index 342fa06..543c09f 100644 --- a/content/2.framework/2.genie.jl/3.API/loader.md +++ b/content/2.framework/2.genie.jl/3.API/loader.md @@ -34,7 +34,10 @@ Sets the module in which the code is loaded (the app's module) :: -::alert{type="info"} Missing docstring for `importenv`. :: + +::alert{type="info"} +Missing docstring for `importenv`. +:: ::ApiCard{object="Genie.Loader.load" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/logger.md b/content/2.framework/2.genie.jl/3.API/logger.md index 086cfb3..4d49b02 100644 --- a/content/2.framework/2.genie.jl/3.API/logger.md +++ b/content/2.framework/2.genie.jl/3.API/logger.md @@ -1,10 +1,16 @@ -::alert{type="info"} Missing docstring for `initialize_logging`. :: +::alert{type="info"} +Missing docstring for `initialize_logging`. +:: -::alert{type="info"} Missing docstring for `timestamp_logger`. :: + + +::alert{type="info"} +Missing docstring for `timestamp_logger`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/renderer-html.md b/content/2.framework/2.genie.jl/3.API/renderer-html.md index 9a28710..86a3096 100644 --- a/content/2.framework/2.genie.jl/3.API/renderer-html.md +++ b/content/2.framework/2.genie.jl/3.API/renderer-html.md @@ -79,11 +79,17 @@ Generates a void HTML element in the form <...> :: -::alert{type="info"} Missing docstring for `skip_element`. :: + +::alert{type="info"} +Missing docstring for `skip_element`. +:: -::alert{type="info"} Missing docstring for `include_markdown`. :: + +::alert{type="info"} +Missing docstring for `include_markdown`. +:: ::ApiCard{object="Genie.Renderer.Html.get_template" category="Function"} @@ -234,7 +240,10 @@ Replaces illegal Julia characters from HTML attributes with safe ones, to be use :: -::alert{type="info"} Missing docstring for `parsehtml`. :: + +::alert{type="info"} +Missing docstring for `parsehtml`. +:: ::ApiCard{object="Genie.Renderer.Html.html_to_julia" category="Function"} @@ -326,11 +335,17 @@ Parses a HTML string into Julia code. :: -::alert{type="info"} Missing docstring for `parse`. :: + +::alert{type="info"} +Missing docstring for `parse`. +:: + -::alert{type="info"} Missing docstring for `parsetags`. :: +::alert{type="info"} +Missing docstring for `parsetags`. +:: ::ApiCard{object="Genie.Renderer.Html.register_elements" category="Function"} @@ -378,7 +393,10 @@ Generates a Julia function representing a "void" HTML element: that is an elemen :: -::alert{type="info"} Missing docstring for `attr`. :: + +::alert{type="info"} +Missing docstring for `attr`. +:: ::ApiCard{object="Genie.Renderer.Html.for_each" category="Function"} @@ -437,6 +455,9 @@ Outputs the rendering of the view within the template. :: -::alert{type="info"} Missing docstring for `el`. :: + +::alert{type="info"} +Missing docstring for `el`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/renderer-js.md b/content/2.framework/2.genie.jl/3.API/renderer-js.md index 114ccfd..6f9eb40 100644 --- a/content/2.framework/2.genie.jl/3.API/renderer-js.md +++ b/content/2.framework/2.genie.jl/3.API/renderer-js.md @@ -1,22 +1,37 @@ -::alert{type="info"} Missing docstring for `get_template`. :: +::alert{type="info"} +Missing docstring for `get_template`. +:: -::alert{type="info"} Missing docstring for `to_js`. :: +::alert{type="info"} +Missing docstring for `to_js`. +:: -::alert{type="info"} Missing docstring for `render`. :: -::alert{type="info"} Missing docstring for `js`. :: +::alert{type="info"} +Missing docstring for `render`. +:: -::alert{type="info"} Missing docstring for `Genie.Router.error`. :: + +::alert{type="info"} +Missing docstring for `js`. +:: + + + + +::alert{type="info"} +Missing docstring for `Genie.Router.error`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/renderer-json.md b/content/2.framework/2.genie.jl/3.API/renderer-json.md index 524b0f3..5906be5 100644 --- a/content/2.framework/2.genie.jl/3.API/renderer-json.md +++ b/content/2.framework/2.genie.jl/3.API/renderer-json.md @@ -1,18 +1,30 @@ -::alert{type="info"} Missing docstring for `render`. :: +::alert{type="info"} +Missing docstring for `render`. +:: -::alert{type="info"} Missing docstring for `Genie.Renderer.render`. :: +::alert{type="info"} +Missing docstring for `Genie.Renderer.render`. +:: -::alert{type="info"} Missing docstring for `json`. :: -::alert{type="info"} Missing docstring for `Genie.Router.error`. :: +::alert{type="info"} +Missing docstring for `json`. +:: + + + + +::alert{type="info"} +Missing docstring for `Genie.Router.error`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/renderer.md b/content/2.framework/2.genie.jl/3.API/renderer.md index 753a69b..d801d15 100644 --- a/content/2.framework/2.genie.jl/3.API/renderer.md +++ b/content/2.framework/2.genie.jl/3.API/renderer.md @@ -12,7 +12,10 @@ Represents an object that can be rendered on the web as a HTTP Response :: -::alert{type="info"} Missing docstring for `render`. :: + +::alert{type="info"} +Missing docstring for `render`. +:: ::ApiCard{object="Genie.Renderer.redirect" category="Function"} @@ -58,7 +61,10 @@ Loads the rendering vars into the task's scope :: -::alert{type="info"} Missing docstring for `injectvars`. :: + +::alert{type="info"} +Missing docstring for `injectvars`. +:: ::ApiCard{object="Genie.Renderer.view_file_info" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/requests.md b/content/2.framework/2.genie.jl/3.API/requests.md index 95d5be0..044fb1d 100644 --- a/content/2.framework/2.genie.jl/3.API/requests.md +++ b/content/2.framework/2.genie.jl/3.API/requests.md @@ -67,9 +67,9 @@ write(io::IO, x) write(filename::AbstractString, x) ``` -Write the canonical binary representation of a value to the given I/O stream or file. Return the number of bytes written into the stream. See also [`print`]() to write a text representation (with an encoding that may depend upon `io`). +Write the canonical binary representation of a value to the given I/O stream or file. Return the number of bytes written into the stream. See also [`print`](@ref) to write a text representation (with an encoding that may depend upon `io`). -The endianness of the written value depends on the endianness of the host system. Convert to/from a fixed endianness when writing/reading (e.g. using [`htol`]() and [`ltoh`]()) to get results that are consistent across platforms. +The endianness of the written value depends on the endianness of the host system. Convert to/from a fixed endianness when writing/reading (e.g. using [`htol`](@ref) and [`ltoh`](@ref)) to get results that are consistent across platforms. You can write multiple values with the same `write` call. i.e. the following are equivalent: @@ -145,13 +145,13 @@ read(io::IO, T) Read a single value of type `T` from `io`, in canonical binary representation. -Note that Julia does not convert the endianness for you. Use [`ntoh`]() or [`ltoh`]() for this purpose. +Note that Julia does not convert the endianness for you. Use [`ntoh`](@ref) or [`ltoh`](@ref) for this purpose. ``` read(io::IO, String) ``` -Read the entirety of `io`, as a `String` (see also [`readchomp`]()). +Read the entirety of `io`, as a `String` (see also [`readchomp`](@ref)). **Examples** diff --git a/content/2.framework/2.genie.jl/3.API/responses.md b/content/2.framework/2.genie.jl/3.API/responses.md index 7e5cb6c..e87f10e 100644 --- a/content/2.framework/2.genie.jl/3.API/responses.md +++ b/content/2.framework/2.genie.jl/3.API/responses.md @@ -1,42 +1,72 @@ -::alert{type="info"} Missing docstring for `getresponse`. :: +::alert{type="info"} +Missing docstring for `getresponse`. +:: -::alert{type="info"} Missing docstring for `getheaders`. :: +::alert{type="info"} +Missing docstring for `getheaders`. +:: -::alert{type="info"} Missing docstring for `setheaders!`. :: -::alert{type="info"} Missing docstring for `setheaders`. :: +::alert{type="info"} +Missing docstring for `setheaders!`. +:: -::alert{type="info"} Missing docstring for `getstatus`. :: +::alert{type="info"} +Missing docstring for `setheaders`. +:: -::alert{type="info"} Missing docstring for `setstatus!`. :: +::alert{type="info"} +Missing docstring for `getstatus`. +:: -::alert{type="info"} Missing docstring for `setstatus`. :: -::alert{type="info"} Missing docstring for `getbody`. :: +::alert{type="info"} +Missing docstring for `setstatus!`. +:: -::alert{type="info"} Missing docstring for `setbody!`. :: +::alert{type="info"} +Missing docstring for `setstatus`. +:: -::alert{type="info"} Missing docstring for `setbody`. :: + + +::alert{type="info"} +Missing docstring for `getbody`. +:: + + + + +::alert{type="info"} +Missing docstring for `setbody!`. +:: + + + + +::alert{type="info"} +Missing docstring for `setbody`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/router.md b/content/2.framework/2.genie.jl/3.API/router.md index 6512800..7f8ded4 100644 --- a/content/2.framework/2.genie.jl/3.API/router.md +++ b/content/2.framework/2.genie.jl/3.API/router.md @@ -32,11 +32,11 @@ show([io::IO = stdout], x) Write a text representation of a value `x` to the output stream `io`. New types `T` should overload `show(io::IO, x::T)`. The representation used by `show` generally includes Julia-specific formatting and type information, and should be parseable Julia code when possible. -[`repr`]() returns the output of `show` as a string. +[`repr`](@ref) returns the output of `show` as a string. -For a more verbose human-readable text output for objects of type `T`, define `show(io::IO, ::MIME"text/plain", ::T)` in addition. Checking the `:compact` [`IOContext`]() key (often checked as `get(io, :compact, false)::Bool`) of `io` in such methods is recommended, since some containers show their elements by calling this method with `:compact => true`. +For a more verbose human-readable text output for objects of type `T`, define `show(io::IO, ::MIME"text/plain", ::T)` in addition. Checking the `:compact` [`IOContext`](@ref) key (often checked as `get(io, :compact, false)::Bool`) of `io` in such methods is recommended, since some containers show their elements by calling this method with `:compact => true`. -See also [`print`](), which writes un-decorated representations. +See also [`print`](@ref), which writes un-decorated representations. **Examples** @@ -55,7 +55,7 @@ Hello World! show(io::IO, mime, x) ``` -The [`display`]() functions ultimately call `show` in order to write an object `x` as a given `mime` type to a given I/O stream `io` (usually a memory buffer), if possible. In order to provide a rich multimedia representation of a user-defined type `T`, it is only necessary to define a new `show` method for `T`, via: `show(io, ::MIME"mime", x::T) = ...`, where `mime` is a MIME-type string and the function body calls [`write`](requests.md#Base.write) (or similar) to write that representation of `x` to `io`. (Note that the `MIME""` notation only supports literal strings; to construct `MIME` types in a more flexible manner use `MIME{Symbol("")}`.) +The [`display`](@ref) functions ultimately call `show` in order to write an object `x` as a given `mime` type to a given I/O stream `io` (usually a memory buffer), if possible. In order to provide a rich multimedia representation of a user-defined type `T`, it is only necessary to define a new `show` method for `T`, via: `show(io, ::MIME"mime", x::T) = ...`, where `mime` is a MIME-type string and the function body calls [`write`](requests.md#Base.write) (or similar) to write that representation of `x` to `io`. (Note that the `MIME""` notation only supports literal strings; to construct `MIME` types in a more flexible manner use `MIME{Symbol("")}`.) For example, if you define a `MyImage` type and know how to write it to a PNG file, you could define a function `show(io, ::MIME"image/png", x::MyImage) = ...` to allow your images to be displayed on any PNG-capable `AbstractDisplay` (such as IJulia). As usual, be sure to `import Base.show` in order to add new methods to the built-in Julia function `show`. @@ -76,7 +76,7 @@ julia> Day(1) 1 day ``` -Container types generally implement 3-argument `show` by calling `show(io, MIME"text/plain"(), x)` for elements `x`, with `:compact => true` set in an [`IOContext`]() passed as the first argument. +Container types generally implement 3-argument `show` by calling `show(io, MIME"text/plain"(), x)` for elements `x`, with `:compact => true` set in an [`IOContext`](@ref) passed as the first argument. source
@@ -170,11 +170,11 @@ julia> push!([1, 2, 3], 4, 5, 6) 6 ``` -If `collection` is ordered, use [`append!`]() to add all the elements of another collection to it. The result of the preceding example is equivalent to `append!([1, 2, 3], [4, 5, 6])`. For `AbstractSet` objects, [`union!`]() can be used instead. +If `collection` is ordered, use [`append!`](@ref) to add all the elements of another collection to it. The result of the preceding example is equivalent to `append!([1, 2, 3], [4, 5, 6])`. For `AbstractSet` objects, [`union!`](@ref) can be used instead. -See [`sizehint!`]() for notes about the performance model. +See [`sizehint!`](@ref) for notes about the performance model. -See also [`pushfirst!`](). +See also [`pushfirst!`](@ref). source
@@ -275,12 +275,14 @@ Gets the `Route` corresponding to `routename` :: + ::alert{type="info"} Missing docstring for `routes`. :: + ::alert{type="info"} Missing docstring for `channels`. :: @@ -370,6 +372,7 @@ Sets up the :action_controller, :action, and :controller key - value pairs of th :: + ::alert{type="info"} Missing docstring for `run_hook`. :: @@ -552,6 +555,7 @@ The collection containing the request variables collection. :: + ::alert{type="info"} Missing docstring for `_params_`. :: @@ -610,6 +614,7 @@ Checks if the requested resource is a static file. :: + ::alert{type="info"} Missing docstring for `to_uri`. :: @@ -713,6 +718,7 @@ Returns the file headers of `f`. :: + ::alert{type="info"} Missing docstring for `ormatch`. :: diff --git a/content/2.framework/2.genie.jl/3.API/server.md b/content/2.framework/2.genie.jl/3.API/server.md index fa8cf6e..7eb9710 100644 --- a/content/2.framework/2.genie.jl/3.API/server.md +++ b/content/2.framework/2.genie.jl/3.API/server.md @@ -67,15 +67,24 @@ Http server handler function - invoked when the server gets a request. :: -::alert{type="info"} Missing docstring for `isrunning`. :: + +::alert{type="info"} +Missing docstring for `isrunning`. +:: + -::alert{type="info"} Missing docstring for `openbrowser`. :: +::alert{type="info"} +Missing docstring for `openbrowser`. +:: + -::alert{type="info"} Missing docstring for `print_server_status`. :: +::alert{type="info"} +Missing docstring for `print_server_status`. +:: ::ApiCard{object="Genie.Server.serve" category="Function"} @@ -106,7 +115,10 @@ julia> Genie.serve("public", 8888, async = false, verbose = true) :: -::alert{type="info"} Missing docstring for `server_status`. :: + +::alert{type="info"} +Missing docstring for `server_status`. +:: ::ApiCard{object="Genie.Server.setup_http_listener" category="Function"} @@ -121,7 +133,10 @@ Configures the handler for the HTTP Request and handles errors. :: -::alert{type="info"} Missing docstring for `setup_http_streamer`. :: + +::alert{type="info"} +Missing docstring for `setup_http_streamer`. +:: ::ApiCard{object="Genie.Server.setup_ws_handler" category="Function"} diff --git a/content/2.framework/2.genie.jl/3.API/sessions.md b/content/2.framework/2.genie.jl/3.API/sessions.md index bf4a952..2cb2384 100644 --- a/content/2.framework/2.genie.jl/3.API/sessions.md +++ b/content/2.framework/2.genie.jl/3.API/sessions.md @@ -1,24 +1,28 @@ + ::alert{type="info"} Missing docstring for `Session`. :: + ::alert{type="info"} Missing docstring for `id`. :: + ::alert{type="info"} Missing docstring for `start`. :: + ::alert{type="info"} Missing docstring for `set!`. :: @@ -58,7 +62,7 @@ julia> get(d, "c", 3) get(f::Function, collection, key) ``` -Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`]() to also store the default value in the dictionary. +Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`](@ref) to also store the default value in the dictionary. This is intended to be called using `do` block syntax @@ -122,7 +126,7 @@ julia> get(d, "c", 3) get(f::Function, collection, key) ``` -Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`]() to also store the default value in the dictionary. +Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`](@ref) to also store the default value in the dictionary. This is intended to be called using `do` block syntax @@ -157,7 +161,7 @@ julia> get(d, "c", 3) get(f::Function, collection, key) ``` -Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`]() to also store the default value in the dictionary. +Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`](@ref) to also store the default value in the dictionary. This is intended to be called using `do` block syntax @@ -192,7 +196,7 @@ julia> get(d, "c", 3) get(f::Function, collection, key) ``` -Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`]() to also store the default value in the dictionary. +Return the value stored for the given key, or if no mapping for the key is present, return `f()`. Use [`get!`](@ref) to also store the default value in the dictionary. This is intended to be called using `do` block syntax @@ -205,36 +209,42 @@ end :: + ::alert{type="info"} Missing docstring for `unset!`. :: + ::alert{type="info"} Missing docstring for `isset`. :: + ::alert{type="info"} Missing docstring for `persist`. :: + ::alert{type="info"} Missing docstring for `load`. :: + ::alert{type="info"} Missing docstring for `session`. :: + ::alert{type="info"} Missing docstring for `init`. :: diff --git a/content/2.framework/2.genie.jl/3.API/toolbox.md b/content/2.framework/2.genie.jl/3.API/toolbox.md index 8b8a3a1..62572b7 100644 --- a/content/2.framework/2.genie.jl/3.API/toolbox.md +++ b/content/2.framework/2.genie.jl/3.API/toolbox.md @@ -1,24 +1,28 @@ + ::alert{type="info"} Missing docstring for `TaskInfo`. :: + ::alert{type="info"} Missing docstring for `TaskResult`. :: + ::alert{type="info"} Missing docstring for `tasks`. :: + ::alert{type="info"} Missing docstring for `VoidTaskResult`. :: @@ -72,7 +76,7 @@ Prints a list of all the registered Genie tasks to the standard output. new, or new{A,B,...} ``` -Special function available to inner constructors which creates a new object of the type. The form new{A,B,...} explicitly specifies values of parameters for parametric types. See the manual section on [Inner Constructor Methods]() for more information. +Special function available to inner constructors which creates a new object of the type. The form new{A,B,...} explicitly specifies values of parameters for parametric types. See the manual section on [Inner Constructor Methods](@ref man-inner-constructor-methods) for more information. source
diff --git a/content/2.framework/2.genie.jl/3.API/util.md b/content/2.framework/2.genie.jl/3.API/util.md index 47cba27..65c178b 100644 --- a/content/2.framework/2.genie.jl/3.API/util.md +++ b/content/2.framework/2.genie.jl/3.API/util.md @@ -1,7 +1,10 @@ -::alert{type="info"} Missing docstring for `expand_nullable`. :: + +::alert{type="info"} +Missing docstring for `expand_nullable`. +:: ::ApiCard{object="Genie.Util.file_name_without_extension" category="Function"} @@ -27,6 +30,9 @@ Recursively walks dir and `produce`s non directories. If `only_files`, directori :: -::alert{type="info"} Missing docstring for `time_to_unixtimestamp`. :: + +::alert{type="info"} +Missing docstring for `time_to_unixtimestamp`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/watch.md b/content/2.framework/2.genie.jl/3.API/watch.md index abe6975..33096d9 100644 --- a/content/2.framework/2.genie.jl/3.API/watch.md +++ b/content/2.framework/2.genie.jl/3.API/watch.md @@ -1,30 +1,51 @@ -::alert{type="info"} Missing docstring for `WATCHED_FOLDERS`. :: +::alert{type="info"} +Missing docstring for `WATCHED_FOLDERS`. +:: -::alert{type="info"} Missing docstring for `WATCHING`. :: +::alert{type="info"} +Missing docstring for `WATCHING`. +:: -::alert{type="info"} Missing docstring for `collect_watched_files`. :: -::alert{type="info"} Missing docstring for `handlers`. :: +::alert{type="info"} +Missing docstring for `collect_watched_files`. +:: -::alert{type="info"} Missing docstring for `unwatch`. :: +::alert{type="info"} +Missing docstring for `handlers`. +:: -::alert{type="info"} Missing docstring for `watch`. :: +::alert{type="info"} +Missing docstring for `unwatch`. +:: -::alert{type="info"} Missing docstring for `watchpath`. :: + + + +::alert{type="info"} +Missing docstring for `watch`. +:: + + + + +::alert{type="info"} +Missing docstring for `watchpath`. +:: diff --git a/content/2.framework/2.genie.jl/3.API/webchannels.md b/content/2.framework/2.genie.jl/3.API/webchannels.md index 54cba2b..a32006c 100644 --- a/content/2.framework/2.genie.jl/3.API/webchannels.md +++ b/content/2.framework/2.genie.jl/3.API/webchannels.md @@ -1,12 +1,14 @@ + ::alert{type="info"} Missing docstring for `ChannelNotFoundException`. :: + ::alert{type="info"} Missing docstring for `ChannelClient`. :: @@ -20,7 +22,7 @@ Missing docstring for `ChannelClient`. Dict([itr]) ``` -`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`]() and hashed with [`hash`](). +`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`](@ref) and hashed with [`hash`](@ref). Given a single iterable argument, constructs a [`Dict`](cookies.md#Base.Dict) whose key-value pairs are taken from 2-tuples `(key,value)` generated by the argument. @@ -54,7 +56,7 @@ Dict{String, Int64} with 2 entries: Dict([itr]) ``` -`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`]() and hashed with [`hash`](). +`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`](@ref) and hashed with [`hash`](@ref). Given a single iterable argument, constructs a [`Dict`](cookies.md#Base.Dict) whose key-value pairs are taken from 2-tuples `(key,value)` generated by the argument. @@ -81,60 +83,70 @@ Dict{String, Int64} with 2 entries: :: + ::alert{type="info"} Missing docstring for `MessagePayload`. :: + ::alert{type="info"} Missing docstring for `ChannelMessage`. :: + ::alert{type="info"} Missing docstring for `CLIENTS`. :: + ::alert{type="info"} Missing docstring for `SUBSCRIPTIONS`. :: + ::alert{type="info"} Missing docstring for `clients`. :: + ::alert{type="info"} Missing docstring for `subscriptions`. :: + ::alert{type="info"} Missing docstring for `websockets`. :: + ::alert{type="info"} Missing docstring for `channels`. :: + ::alert{type="info"} Missing docstring for `connected_clients`. :: + ::alert{type="info"} Missing docstring for `disconnected_clients`. :: diff --git a/content/2.framework/2.genie.jl/3.API/webthreads.md b/content/2.framework/2.genie.jl/3.API/webthreads.md index b52ab20..b8c131a 100644 --- a/content/2.framework/2.genie.jl/3.API/webthreads.md +++ b/content/2.framework/2.genie.jl/3.API/webthreads.md @@ -1,24 +1,28 @@ + ::alert{type="info"} Missing docstring for `CLIENTS`. :: + ::alert{type="info"} Missing docstring for `MESSAGE_QUEUE`. :: + ::alert{type="info"} Missing docstring for `SUBSCRIPTIONS`. :: + ::alert{type="info"} Missing docstring for `ChannelClient`. :: @@ -32,7 +36,7 @@ Missing docstring for `ChannelClient`. Dict([itr]) ``` -`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`]() and hashed with [`hash`](). +`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`](@ref) and hashed with [`hash`](@ref). Given a single iterable argument, constructs a [`Dict`](cookies.md#Base.Dict) whose key-value pairs are taken from 2-tuples `(key,value)` generated by the argument. @@ -59,6 +63,7 @@ Dict{String, Int64} with 2 entries: :: + ::alert{type="info"} Missing docstring for `ChannelMessage`. :: @@ -72,7 +77,7 @@ Missing docstring for `ChannelMessage`. Dict([itr]) ``` -`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`]() and hashed with [`hash`](). +`Dict{K,V}()` constructs a hash table with keys of type `K` and values of type `V`. Keys are compared with [`isequal`](@ref) and hashed with [`hash`](@ref). Given a single iterable argument, constructs a [`Dict`](cookies.md#Base.Dict) whose key-value pairs are taken from 2-tuples `(key,value)` generated by the argument. @@ -122,13 +127,14 @@ String <: AbstractString The default string type in Julia, used by e.g. string literals. -`String`s are immutable sequences of `Char`s. A `String` is stored internally as a contiguous byte array, and while they are interpreted as being UTF-8 encoded, they can be composed of any byte sequence. Use [`isvalid`]() to validate that the underlying byte sequence is valid as UTF-8. +`String`s are immutable sequences of `Char`s. A `String` is stored internally as a contiguous byte array, and while they are interpreted as being UTF-8 encoded, they can be composed of any byte sequence. Use [`isvalid`](@ref) to validate that the underlying byte sequence is valid as UTF-8. source
:: + ::alert{type="info"} Missing docstring for `MessagePayload`. :: @@ -145,24 +151,28 @@ Pushes `msg` (and `payload`) to all the clients subscribed to all the channels. :: + ::alert{type="info"} Missing docstring for `channels`. :: + ::alert{type="info"} Missing docstring for `clients`. :: + ::alert{type="info"} Missing docstring for `connected_clients`. :: + ::alert{type="info"} Missing docstring for `disconnected_clients`. :: @@ -189,12 +199,14 @@ Removes all subscriptions of `client`. :: + ::alert{type="info"} Missing docstring for `pull`. :: + ::alert{type="info"} Missing docstring for `push`. :: @@ -215,12 +227,14 @@ Subscribes a web thread client `wt` to `channel`. :: + ::alert{type="info"} Missing docstring for `subscriptions`. :: + ::alert{type="info"} Missing docstring for `timestamp_client`. :: @@ -241,6 +255,7 @@ Unsubscribes a web socket client `wt` from all the channels. :: + ::alert{type="info"} Missing docstring for `unsubscribe_clients`. :: @@ -256,6 +271,7 @@ Unsubscribes clients which are no longer connected. :: + ::alert{type="info"} Missing docstring for `webthreads`. :: diff --git a/content/2.framework/2.genie.jl/4.Plugins/GenieAuthentication/_dir.yml b/content/2.framework/2.genie.jl/4.Plugins/GenieAuthentication/_dir.yml new file mode 100644 index 0000000..506c01f --- /dev/null +++ b/content/2.framework/2.genie.jl/4.Plugins/GenieAuthentication/_dir.yml @@ -0,0 +1 @@ +title: GenieAuthentication \ No newline at end of file diff --git a/content/2.framework/2.genie.jl/3.API/GenieAuthentication/genieauthentication.md b/content/2.framework/2.genie.jl/4.Plugins/GenieAuthentication/genieauthentication.md similarity index 100% rename from content/2.framework/2.genie.jl/3.API/GenieAuthentication/genieauthentication.md rename to content/2.framework/2.genie.jl/4.Plugins/GenieAuthentication/genieauthentication.md diff --git a/content/2.framework/2.genie.jl/4.Plugins/GenieAuthorisation/_dir.yml b/content/2.framework/2.genie.jl/4.Plugins/GenieAuthorisation/_dir.yml new file mode 100644 index 0000000..167a712 --- /dev/null +++ b/content/2.framework/2.genie.jl/4.Plugins/GenieAuthorisation/_dir.yml @@ -0,0 +1 @@ +title: GenieAuthorisation \ No newline at end of file diff --git a/content/2.framework/2.genie.jl/3.API/GenieAuthorisation/genieauthorisation.md b/content/2.framework/2.genie.jl/4.Plugins/GenieAuthorisation/genieauthorisation.md similarity index 100% rename from content/2.framework/2.genie.jl/3.API/GenieAuthorisation/genieauthorisation.md rename to content/2.framework/2.genie.jl/4.Plugins/GenieAuthorisation/genieauthorisation.md diff --git a/content/2.framework/2.genie.jl/4.Plugins/GenieAutoreload/0.index.md b/content/2.framework/2.genie.jl/4.Plugins/GenieAutoreload/0.index.md new file mode 100644 index 0000000..c020a63 --- /dev/null +++ b/content/2.framework/2.genie.jl/4.Plugins/GenieAutoreload/0.index.md @@ -0,0 +1,33 @@ +# GenieAutoReload plugin + +## Auto reload functionality for Genie plugins. + +GenieAutoReload monitors the indicated files and folders (recursively) and automatically recompiles the Julia code and reloads the corresponding browser window. + +To use in the app, add the following lines of code: + +```julia +using Genie, Genie.Renderer.Html # some app deps + +# load GenieAutoReload +using GenieAutoReload + +# UI rendering code +# As part of the HTML UI code we need to load the autoreload.js file +# so this needs to be added in order to output the corresponding +# +Hello " ``` @@ -28,7 +28,7 @@ julia> layout([ julia> layout([ span("Hello", @text(:greeting)) ], partial = true) -"Hello +"Hello " ``` @@ -51,7 +51,7 @@ julia> page(:elemid, [ span("Hello", @text(:greeting)) ]) " -
Hello
+
Hello
" ``` @@ -61,10 +61,12 @@ julia> page(:elemid, [ ```julia -function row(args...; kwargs...) +function row(args...; size=-1, xs=-1, sm=-1, md=-1, lg=-1, xl=-1, kwargs...) ``` -Creates a `div` HTML element with a CSS class named `row`. This works with Stipple's core layout and with [Quasar's Flex Grid](https://quasar.dev/layout/grid/introduction-to-flexbox) to create the responsive CSS grid of the web page. The `row()` function creates rows which should include [`cell`](layout.md#Stipple.Layout.cell)s. +Creates a `div` HTML element with Quasar's Flexgrid CSS class `row`. Such rows typically contain elements created with [`cell`](layout.md#Stipple.Layout.cell), `row`, [`column`](layout.md#Stipple.Layout.column) or other elements that manually receive grid classes, e.g. `"col"`, `"col-sm-5"`. + +The grid size kwargs `size`, `xs`, etc. are explained in more detail in the docs of [`cell`](layout.md#Stipple.Layout.cell). **Example** @@ -73,6 +75,26 @@ julia> row(span("Hello")) "
Hello
" ``` +:: +::ApiCard{object="Stipple.Layout.column" category="Function"} +#docstring + + +```julia +function column(args...; size=-1, xs=-1, sm=-1, md=-1, lg=-1, xl=-1, kwargs...) +``` + +Creates a `div` HTML element with Quasar's Flexgrid CSS class `column`. Such columns typically contain elements created with [`cell`](layout.md#Stipple.Layout.cell), [`row`](layout.md#Stipple.Layout.row), `column`, or other elements that manually receive grid classes, e.g. `"col"`, `"col-sm-5"`. + +The grid size kwargs `size`, `xs`, etc. are explained in more detail in the docs of [`cell`](layout.md#Stipple.Layout.cell). + +**Example** + +```julia +julia> column(span("Hello")) +"
Hello
" +``` + :: ::ApiCard{object="Stipple.Layout.cell" category="Function"} #docstring @@ -82,14 +104,20 @@ julia> row(span("Hello")) function cell(args...; size::Int=0, xs::Int=0, sm::Int=0, md::Int=0, lg::Int=0, xl::Int=0, kwargs...) ``` -Creates a `div` HTML element with Quasar flex grid CSS class named `col`. If size is specified, the class `col-$size` is added instead. [Quasar's Flex Grid](https://quasar.dev/layout/grid/introduction-to-flexbox) supports the following values for size arguments: +Creates a `div` HTML element with Quasar's flex grid CSS class `col`. Moreover, cells are of the class `st-col`, which is controlled by the Stipple theme. + +If size is specified, the class `col-$size` is added instead. + +If tag classes (`xs`, `sm`, `md`, `lg`, `xl`) are specified, the respective classes `col-$tag-$md` are added, e.g. `col-sm-6`. - * Integer values between `0` and `12`; `0` means no specification - * AbStractString values `"1"` - `"12"`, `""` or `"auto"`; `""` means no specification, `"auto"` means height/width from content +Parameters: -If tag classes (`xs`, `sm`, `md`, `lg`, `xl`) are specified, the respective classes `col-$tag-$md` are added, e.g. `col-sm-6`. The cells should be included within [`row`](layout.md#Stipple.Layout.row)s or [`column`]()s. + * `""` / `0`: shared remaining space (e.g. `"col"`, `"col-sm"`) + * `1` - `12` / `"1"` - `"12"`: column width (e.g. `"col-5"`, `"col-sm-5"`) + * `"auto"`/`:auto`: height/width from content (`"col-auto"`, `"col-sm-auto"`) + * `-1` / `nothing`: no specification -Moreover, cells are of the class `st-col`, which is controlled by the Stipple theme. +The cells are typically included within [`row`](layout.md#Stipple.Layout.row)s or [`column`](layout.md#Stipple.Layout.column)s. See [Quasar's Flex Grid](https://quasar.dev/layout/grid/introduction-to-flexbox) for more information. **Example** @@ -107,7 +135,7 @@ julia> row(cell(size = 2, md = 6, sm = 12, span("Hello"))) function theme() :: String ``` -Provides theming support for Stipple apps and pages. It includes Stipple's default CSS files and additional elements, in the form of HTML tags, can be injected by pushing to the `Stipple.Layout.THEMES` collection. +Provides theming support for Stipple apps and pages. It includes Stipple's default CSS files and additional elements, in the form of HTML tags, can be injected by pushing to the `Stipple.Layout.THEMES[][]` collection. **Example** @@ -118,7 +146,7 @@ julia> theme() julia> StippleUI.theme() "" -julia> push!(Stipple.Layout.THEMES, StippleUI.theme) +julia> push!(Stipple.Layout.THEMES[], StippleUI.theme) ``` :: diff --git a/content/2.framework/3.stipple.jl/3.API/namedtuples.md b/content/2.framework/3.stipple.jl/3.API/namedtuples.md index d49521a..ee86f92 100644 --- a/content/2.framework/3.stipple.jl/3.API/namedtuples.md +++ b/content/2.framework/3.stipple.jl/3.API/namedtuples.md @@ -8,15 +8,15 @@ NamedTuple ``` -`NamedTuple`s are, as their name suggests, named [`Tuple`]()s. That is, they're a tuple-like collection of values, where each entry has a unique name, represented as a [`Symbol`](). Like `Tuple`s, `NamedTuple`s are immutable; neither the names nor the values can be modified in place after construction. +`NamedTuple`s are, as their name suggests, named [`Tuple`](@ref)s. That is, they're a tuple-like collection of values, where each entry has a unique name, represented as a [`Symbol`](@ref). Like `Tuple`s, `NamedTuple`s are immutable; neither the names nor the values can be modified in place after construction. -Accessing the value associated with a name in a named tuple can be done using field access syntax, e.g. `x.a`, or using [`getindex`](), e.g. `x[:a]` or `x[(:a, :b)]`. A tuple of the names can be obtained using [`keys`](), and a tuple of the values can be obtained using [`values`](). +Accessing the value associated with a name in a named tuple can be done using field access syntax, e.g. `x.a`, or using [`getindex`](@ref), e.g. `x[:a]` or `x[(:a, :b)]`. A tuple of the names can be obtained using [`keys`](@ref), and a tuple of the values can be obtained using [`values`](@ref). !!! note - Iteration over `NamedTuple`s produces the *values* without the names. (See example below.) To iterate over the name-value pairs, use the [`pairs`]() function. + Iteration over `NamedTuple`s produces the *values* without the names. (See example below.) To iterate over the name-value pairs, use the [`pairs`](@ref) function. -The [`@NamedTuple`]() macro can be used for conveniently declaring `NamedTuple` types. +The [`@NamedTuple`](@ref) macro can be used for conveniently declaring `NamedTuple` types. **Examples** diff --git a/content/2.framework/3.stipple.jl/3.API/stipple.md b/content/2.framework/3.stipple.jl/3.API/stipple.md index b76014e..0dc155d 100644 --- a/content/2.framework/3.stipple.jl/3.API/stipple.md +++ b/content/2.framework/3.stipple.jl/3.API/stipple.md @@ -1,11 +1,24 @@ +::ApiCard{object="Stipple.Reactive" category="Type"} +#docstring -::alert{type="info"} -Missing docstring for `Reactive`. -:: +```julia + mutable struct Reactive{T} <: Observables.AbstractObservable{T} +``` + +`Reactive` is a the base type for variables that are handled by a model. It is an `AbstractObservable` of which the content is obtained by appending `[]` after the `Reactive` variable's name. For convenience, `Reactive` can be abbreviated by `R`. + +There are several methods of creating a Reactive variable: + + * `r = Reactive(8)` + * `r = Reactive{Float64}(8)` + * `r = Reactive{Float64}(8, READONLY)` + * `r = Reactive{String}("Hello", PRIVATE)` + * `r = Reactive(jsfunction"console.log('Hi')", JSFUNCTION)` +:: ::ApiCard{object="Stipple.ReactiveModel" category="Type"} #docstring @@ -29,32 +42,16 @@ end :: -::alert{type="info"} -Missing docstring for `@reactors`. -:: - - ::alert{type="info"} -Missing docstring for `@reactive`. +Missing docstring for `Settings # missing docstring`. :: -::alert{type="info"} -Missing docstring for `@reactive!`. -:: - - ::alert{type="info"} -Missing docstring for `Settings`. -:: - - - -::alert{type="info"} -Missing docstring for `MissingPropertyException`. +Missing docstring for `MissingPropertyException # missing docstring`. :: @@ -380,14 +377,16 @@ Change the field of a ReactiveModel without triggering the listeners. If keys ar :: + ::alert{type="info"} -Missing docstring for `convertvalue`. +Missing docstring for `convertvalue # missing docstring`. :: + ::alert{type="info"} -Missing docstring for `stipple_parse`. +Missing docstring for `stipple_parse # missing docstring`. :: @@ -415,8 +414,9 @@ hs_model = Stipple.init(HelloPie) :: + ::alert{type="info"} -Missing docstring for `stipple_deps`. +Missing docstring for `stipple_deps # missing docstring`. :: @@ -437,7 +437,7 @@ Configures the reactive handlers for the reactive properties of the model. Calle ```julia Base.push!(app::M, vals::Pair{Symbol,T}; channel::String, - except::Union{Genie.WebChannels.HTTP.WebSockets.WebSocket,Nothing,UInt}) where {T,M<:ReactiveModel} + except::Union{Nothing,UInt,Vector{UInt}}) where {T,M<:ReactiveModel} ``` Pushes data payloads over to the frontend by broadcasting the `vals` through the `channel`. @@ -495,8 +495,9 @@ Replaces all JSONText values on a copy of the input, see [`replace_jsfunction!`] :: + ::alert{type="info"} -Missing docstring for `deps_routes`. +Missing docstring for `deps_routes # missing docstring`. :: @@ -511,12 +512,27 @@ function deps(channel::String = Genie.config.webchannels_default_route) Outputs the HTML code necessary for injecting the dependencies in the page (the