More docs updates
parent
183afb4834
commit
40e07dbea0
|
@ -1,7 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@silverbulletmd/silverbullet",
|
"name": "@silverbulletmd/silverbullet",
|
||||||
"version": "0.9.0",
|
"version": "0.9.0",
|
||||||
"description": "Silverbullet is a Personal Knowledge Management System",
|
|
||||||
"exports": {
|
"exports": {
|
||||||
"./syscall": "./plug-api/syscall.ts",
|
"./syscall": "./plug-api/syscall.ts",
|
||||||
"./syscalls": "./plug-api/syscalls.ts",
|
"./syscalls": "./plug-api/syscalls.ts",
|
||||||
|
|
|
@ -3,6 +3,7 @@ import { syscall } from "../syscall.ts";
|
||||||
/**
|
/**
|
||||||
* Implements a very simple (string) key value store for the client.
|
* Implements a very simple (string) key value store for the client.
|
||||||
* Generally should only be used to set some client-specific states, such as preferences.
|
* Generally should only be used to set some client-specific states, such as preferences.
|
||||||
|
* @module
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -3,6 +3,7 @@ import type { KV, KvKey, KvQuery } from "../types.ts";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Exposes a key value story with query capabilities.
|
* Exposes a key value story with query capabilities.
|
||||||
|
* @module
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -6,6 +6,7 @@ import type { FilterOption } from "@silverbulletmd/silverbullet/type/client";
|
||||||
/**
|
/**
|
||||||
* Exposes various editor utilities.
|
* Exposes various editor utilities.
|
||||||
* Important: These syscalls are only available in the client.
|
* Important: These syscalls are only available in the client.
|
||||||
|
* @module
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -1,5 +1,10 @@
|
||||||
import { syscall } from "../syscall.ts";
|
import { syscall } from "../syscall.ts";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exposes the SilverBullet event bus.
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Triggers an event on the SilverBullet event bus.
|
* Triggers an event on the SilverBullet event bus.
|
||||||
* This can be used to implement an RPC-style system too, because event handlers can return values,
|
* This can be used to implement an RPC-style system too, because event handlers can return values,
|
||||||
|
|
|
@ -3,6 +3,7 @@ import type { MQStats } from "../types.ts";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implements a simple Message Queue system.
|
* Implements a simple Message Queue system.
|
||||||
|
* @module
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -1,6 +1,11 @@
|
||||||
import { syscall } from "../syscall.ts";
|
import { syscall } from "../syscall.ts";
|
||||||
import type { AttachmentMeta, FileMeta, PageMeta } from "../types.ts";
|
import type { AttachmentMeta, FileMeta, PageMeta } from "../types.ts";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exposes the space with its pages, attachments and plugs.
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Lists all pages (files ending in .md) in the space.
|
* Lists all pages (files ending in .md) in the space.
|
||||||
* @param unfiltered
|
* @param unfiltered
|
||||||
|
|
|
@ -2,6 +2,7 @@ import { syscall } from "../syscall.ts";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Syscalls that interact with the sync engine (when the client runs in Sync mode)
|
* Syscalls that interact with the sync engine (when the client runs in Sync mode)
|
||||||
|
* @module
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -4,6 +4,11 @@ import type { ParseTree } from "../lib/tree.ts";
|
||||||
import { syscall } from "../syscall.ts";
|
import { syscall } from "../syscall.ts";
|
||||||
import type { Config } from "../../type/config.ts";
|
import type { Config } from "../../type/config.ts";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* System level syscalls
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Invoke a plug function
|
* Invoke a plug function
|
||||||
* @param name a string representing the name of the function to invoke ("plug.functionName")
|
* @param name a string representing the name of the function to invoke ("plug.functionName")
|
||||||
|
|
|
@ -1,5 +1,10 @@
|
||||||
import { syscall } from "../syscall.ts";
|
import { syscall } from "../syscall.ts";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* YAML operations
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a YAML string into a JavaScript object.
|
* Parses a YAML string into a JavaScript object.
|
||||||
* @param text the YAML text to parse
|
* @param text the YAML text to parse
|
||||||
|
|
Loading…
Reference in New Issue