diff --git a/docs/docs/reference/01_init.md b/docs/docs/reference/01_init.md new file mode 100644 index 000000000..c10c20c7b --- /dev/null +++ b/docs/docs/reference/01_init.md @@ -0,0 +1,47 @@ +--- +title: "init" +--- + +`init` is the main entrypoint for mounting your application and its custom logic. It is a reserved function that Jan will look for to initialize your application. + +## Usage + +```js +// javascript +const core = require("@janhq/core"); + +// typescript +import * as core from "@janhq/core"; +``` + +## init + +TODO + +## RegisterExtensionPoint + +`RegisterExtensionPoint` is used for app initialization. + +It lets you register functions/methods with the main application. + +```js +import { RegisterExtensionPoint } from "@janhq/core"; +``` + +```js +type RegisterExtensionPoint = ( + extensionName: string, + extensionId: string, + method: Function, + priority?: number +) +``` + +## invokePluginFunc + +```js +// index.ts +function foo(id: number) { + return core.invokePluginFunc(MODULE_PATH, "getConvMessages", id); +} +``` diff --git a/docs/docs/reference/coreservice.md b/docs/docs/reference/02_coreservice.md similarity index 99% rename from docs/docs/reference/coreservice.md rename to docs/docs/reference/02_coreservice.md index 328489bc3..c9a7801be 100644 --- a/docs/docs/reference/coreservice.md +++ b/docs/docs/reference/02_coreservice.md @@ -1,5 +1,4 @@ --- -sidebar_position: 1 title: "CoreService" --- diff --git a/docs/docs/reference/events.md b/docs/docs/reference/03_events.md similarity index 97% rename from docs/docs/reference/events.md rename to docs/docs/reference/03_events.md index 5f3a03ab5..b86084cdc 100644 --- a/docs/docs/reference/events.md +++ b/docs/docs/reference/03_events.md @@ -1,5 +1,4 @@ --- -sidebar_position: 2 title: "events" --- diff --git a/docs/docs/reference/04_store.md b/docs/docs/reference/04_store.md new file mode 100644 index 000000000..3dc7c6a5e --- /dev/null +++ b/docs/docs/reference/04_store.md @@ -0,0 +1,15 @@ +--- +title: "store" +--- + +`store` is a helper object for working with Jan app's local storage database. + +By default, Jan ships with a [pouchDB](https://pouchdb.com/) client side noSQL db to persist usage state. + +_Note: default `store` logic is from [@data-plugin](https://www.npmjs.com/package/@janhq/data-plugin) which implements `StoreService`._ + +## Usage + +```js +import { store } from "@janhq/core"; +``` diff --git a/docs/docs/reference/filesystem.md b/docs/docs/reference/05_filesystem.md similarity index 93% rename from docs/docs/reference/filesystem.md rename to docs/docs/reference/05_filesystem.md index d9d863e46..3583492a7 100644 --- a/docs/docs/reference/filesystem.md +++ b/docs/docs/reference/05_filesystem.md @@ -1,5 +1,4 @@ --- -sidebar_position: 5 title: "filesystem" --- diff --git a/docs/docs/reference/06_preferences.md b/docs/docs/reference/06_preferences.md new file mode 100644 index 000000000..1f00879b9 --- /dev/null +++ b/docs/docs/reference/06_preferences.md @@ -0,0 +1,19 @@ +--- +title: "preferences" +--- + +`preferences` is a helper object for adding settings fields to your apps. + +## Usage + +```js +todo; +``` + +## registerPreferences + +## get + +## set + +## clear diff --git a/docs/docs/reference/preferences.md b/docs/docs/reference/preferences.md deleted file mode 100644 index 807665863..000000000 --- a/docs/docs/reference/preferences.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 4 -title: "preferences" ---- - -## Usage diff --git a/docs/docs/reference/store.md b/docs/docs/reference/store.md deleted file mode 100644 index 32efae979..000000000 --- a/docs/docs/reference/store.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar_position: 3 -title: "store" ---- - -`store` is a helper library for working with Jan app's local storage database. - -Jan ships with a [pouchDB](https://pouchdb.com/) client side noSQL db to persist usage state -store (logic from @data-plugin which implements StoreService) - -## Usage - -```js -import { store } from "@janhq/core"; -``` diff --git a/docs/sidebars.js b/docs/sidebars.js index 0f8bb619c..ef67d1581 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -63,7 +63,7 @@ const sidebars = { type: "category", label: "Reference", collapsible: true, - collapsed: false, + collapsed: true, items: [ { type: "autogenerated",