mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-07-29 02:18:40 +00:00
Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e22e25afe2 | |||
| dc28e1585c | |||
| 6d7bceb536 | |||
| 795ce1ab55 | |||
| e83c095d97 | |||
| b5ddb3ecc2 | |||
| e10ae19992 | |||
| 4a873a32d4 | |||
| 1c8b6f91b1 | |||
| 2ec22b1f9b | |||
| c1cad438ba |
@@ -2,8 +2,8 @@ name: Publish to docs site
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
tags:
|
||||
- "v*"
|
||||
jobs:
|
||||
build-docs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
Generated
+8
-61
@@ -1,16 +1,16 @@
|
||||
{
|
||||
"name": "@showbridge/docs",
|
||||
"version": "0.1.2",
|
||||
"version": "0.3.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@showbridge/docs",
|
||||
"version": "0.1.2",
|
||||
"version": "0.3.0",
|
||||
"devDependencies": {
|
||||
"@astrojs/check": "0.9.9",
|
||||
"@astrojs/starlight": "^0.39.2",
|
||||
"astro": "^6.3.1",
|
||||
"astro": "^6.3.8",
|
||||
"sharp": "0.34.5",
|
||||
"typescript": "6.0.3"
|
||||
}
|
||||
@@ -2336,15 +2336,15 @@
|
||||
}
|
||||
},
|
||||
"node_modules/astro": {
|
||||
"version": "6.3.1",
|
||||
"resolved": "https://registry.npmjs.org/astro/-/astro-6.3.1.tgz",
|
||||
"integrity": "sha512-atz6dmkE3Gu24bDgb7g2RE/BYnKqPYIHd6hTUM1UXvu/i7qNZOKLAqEHvgYpv9PQVcgWsXpk4/OOXZ0E/FzvSQ==",
|
||||
"version": "6.3.8",
|
||||
"resolved": "https://registry.npmjs.org/astro/-/astro-6.3.8.tgz",
|
||||
"integrity": "sha512-xH2UA8Z17IS+JaqSlSkBor7jO6gd7zXTLdmu06nKpfpDDJFbi/7KZEy3NDmWxmier+6XrCZ9Z4aitO8jhC9oiA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@astrojs/compiler": "^4.0.0",
|
||||
"@astrojs/internal-helpers": "0.9.0",
|
||||
"@astrojs/markdown-remark": "7.1.1",
|
||||
"@astrojs/internal-helpers": "0.9.1",
|
||||
"@astrojs/markdown-remark": "7.1.2",
|
||||
"@astrojs/telemetry": "3.3.2",
|
||||
"@capsizecss/unpack": "^4.0.0",
|
||||
"@clack/prompts": "^1.1.0",
|
||||
@@ -2434,59 +2434,6 @@
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/astro/node_modules/@astrojs/internal-helpers": {
|
||||
"version": "0.9.0",
|
||||
"resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.9.0.tgz",
|
||||
"integrity": "sha512-GdYkzR26re8izmyYlBqf4z2s7zNngmWLFuxw0UKiPNqHraZGS6GKWIwSHgS22RDlu2ePFJ8bzmpBcUszut/SDg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"picomatch": "^4.0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/astro/node_modules/@astrojs/markdown-remark": {
|
||||
"version": "7.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-7.1.1.tgz",
|
||||
"integrity": "sha512-C6e9BnLGlbdv6bV8MYGeHpHxsUHrCrB4OuRLqi5LI7oiBVcBcqfUN06zpwFQdHgV48QCCrMmLpyqBr7VqC+swA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@astrojs/internal-helpers": "0.9.0",
|
||||
"@astrojs/prism": "4.0.1",
|
||||
"github-slugger": "^2.0.0",
|
||||
"hast-util-from-html": "^2.0.3",
|
||||
"hast-util-to-text": "^4.0.2",
|
||||
"js-yaml": "^4.1.1",
|
||||
"mdast-util-definitions": "^6.0.0",
|
||||
"rehype-raw": "^7.0.0",
|
||||
"rehype-stringify": "^10.0.1",
|
||||
"remark-gfm": "^4.0.1",
|
||||
"remark-parse": "^11.0.0",
|
||||
"remark-rehype": "^11.1.2",
|
||||
"remark-smartypants": "^3.0.2",
|
||||
"retext-smartypants": "^6.2.0",
|
||||
"shiki": "^4.0.0",
|
||||
"smol-toml": "^1.6.0",
|
||||
"unified": "^11.0.5",
|
||||
"unist-util-remove-position": "^5.0.0",
|
||||
"unist-util-visit": "^5.1.0",
|
||||
"unist-util-visit-parents": "^6.0.2",
|
||||
"vfile": "^6.0.3"
|
||||
}
|
||||
},
|
||||
"node_modules/astro/node_modules/@astrojs/prism": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/@astrojs/prism/-/prism-4.0.1.tgz",
|
||||
"integrity": "sha512-nksZQVjlferuWzhPsBpQ1JE5XuKAf1id1/9Hj4a9KG4+ofrlzxUUwX4YGQF/SuDiuiGKEnzopGOt38F3AnVWsQ==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"prismjs": "^1.30.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=22.12.0"
|
||||
}
|
||||
},
|
||||
"node_modules/astro/node_modules/jsonc-parser": {
|
||||
"version": "3.3.1",
|
||||
"resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz",
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@showbridge/docs",
|
||||
"type": "module",
|
||||
"version": "0.1.2",
|
||||
"version": "0.3.0",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
@@ -16,7 +16,7 @@
|
||||
"devDependencies": {
|
||||
"@astrojs/check": "0.9.9",
|
||||
"@astrojs/starlight": "^0.39.2",
|
||||
"astro": "^6.3.1",
|
||||
"astro": "^6.3.8",
|
||||
"sharp": "0.34.5",
|
||||
"typescript": "6.0.3"
|
||||
}
|
||||
|
||||
@@ -10,6 +10,8 @@ The `db.sqlite` module can open/create SQLite databases
|
||||
- **params**:
|
||||
- **dsn**: the data source name, this can be a file path or the special `:memory:` name for an in-memory DB
|
||||
|
||||
This module implements the `DatabaseModule` interface.
|
||||
|
||||
## Cap
|
||||
|
||||
### Example snippet
|
||||
|
||||
@@ -13,6 +13,8 @@ The `mqtt.client` module connects to a MQTT broker and emits a message messages
|
||||
- **topic** mqtt topic to subscribe to
|
||||
- **clientId** client ID for this connection to the broker
|
||||
|
||||
This module implements the `PubSubModule` interface.
|
||||
|
||||
### Example
|
||||
|
||||
Open a mqtt connection to `test.mosquitto.org` subscribing to the `showbridge` topic.
|
||||
|
||||
@@ -12,6 +12,8 @@ This module connects to a [NATS](https://nats.io/) server and subscribes to a su
|
||||
- **url**: the URL of the NATS server to connect to (e.g. `nats://localhost:4222`)
|
||||
- **subject**: the subject to subscribe to
|
||||
|
||||
This module implements the `PubSubModule` interface.
|
||||
|
||||
### Example
|
||||
|
||||
Connect to a local NATS server and subscribe to the `events` subject
|
||||
|
||||
@@ -12,6 +12,8 @@ The `redis.client` module connects to a Redis server. This module does not produ
|
||||
- **host**: the Redis server host
|
||||
- **port**: the Redis server port
|
||||
|
||||
This module implements the `KeyValueModule` interface.
|
||||
|
||||
### Example
|
||||
|
||||
Connect to a Redis server running on `localhost` at port `6379`.
|
||||
|
||||
@@ -6,6 +6,8 @@ sidebar:
|
||||
---
|
||||
|
||||
The `db.query` processor will issue a query to the specified module and return the result to the next processor in line.
|
||||
The module must implement the `DatabaseModule` interface for this processor to work.
|
||||
This processor will return an error if any of the required parameters are missing/invalid or if the module does not implement the `DatabaseModule` interface.
|
||||
|
||||
- **type**: `db.query`
|
||||
- **params**:
|
||||
|
||||
@@ -10,7 +10,7 @@ This processor will create a new HTTP response with the specified status code an
|
||||
- **type**: `http.response.create`
|
||||
- **params**:
|
||||
- **status**: the HTTP status code to set for the response (e.g. `200`, `404`, etc.)
|
||||
- **body**: the body template to set for the response
|
||||
- **bodyTemplate**: the body template to set for the response
|
||||
|
||||
### Example
|
||||
|
||||
@@ -20,5 +20,5 @@ This would create an HTTP response with a status code of `200` and a body of `OK
|
||||
- type: http.response.create
|
||||
params:
|
||||
status: 200
|
||||
body: "OK"
|
||||
bodyTemplate: "OK"
|
||||
```
|
||||
|
||||
@@ -5,7 +5,8 @@ sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
The `kv.get` processor gets the value associated with a key from a compatible module. The output payload is the value if the key is found.
|
||||
The `kv.get` processor gets the value associated with a key from a module that implements the `KeyValueModule` interface.
|
||||
The output payload is the value if the key is found.
|
||||
|
||||
- **type**: `kv.get`
|
||||
- **params**:
|
||||
|
||||
@@ -5,7 +5,7 @@ sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
The `kv.set` processor sets the value associated with a key from a compatible module. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
The `kv.set` processor sets the value associated with a key from a module that implements the `KeyValueModule` interface. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
|
||||
- **type**: `kv.set`
|
||||
- **params**:
|
||||
|
||||
@@ -5,7 +5,9 @@ sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
This processor will publish the incoming payload to a Pub/Sub capable module. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
|
||||
This processor will publish the incoming payload to a module that implements the `PubSubModule` interface.
|
||||
This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
|
||||
The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
|
||||
- **type**: `pubsub.publish`
|
||||
- **params**:
|
||||
|
||||
Reference in New Issue
Block a user