Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 10:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Error fixes, update About index, update contribute/teach (now contribute/content)

Browse Source
This commit is contained in:
kn0wmad
2022-08-18 11:00:33 -06:00
parent b0cba08a4d
commit dd8004ca7f
6 changed files with 105 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
site/source/developer-docs/specification/js-procedure.rst
View File

@@ -1,4 +1,4 @@
.. _js_procedure:
.. _js-procedure:
============
JS Procedure
@@ -58,10 +58,10 @@ How to Setup
export const dependencies: T.ExpectedExports.dependencies = todo;
/** Fill this out when manifest @ health-checks.<packageName>.type = script */
export const health: T.ExpectedExports.health = todo;
/** Fill this out when manifest @ migrations.<from/to>.<emver>.type = script
/** Fill this out when manifest @ migrations.<from/to>.<emver>.type = script */
export const migration: T.ExpectedExports.migration = todo;
Note: Not all the exports are needed unless one uses the following configuration settings in ``manifest.yaml``
.. note:: Not all the exports are needed unless one uses the following configuration settings in ``manifest.yaml``
3. Modify service manifest to use the script type like so:
@@ -73,8 +73,8 @@ How to Setup
set:
type: script
4. Fill in the todos in the above template to match the expected Effect parameter defined by the `exported type <https://deno.land/x/embassyd_sdk@v0.3.1.0.3/types.ts#L32> `__. This type describes how to call functions that interact with EmbassyOS.
5. In the build process for packaging the final s9pk, include the following step. **The location of the js is important, and can't be changed**. It must exist at `scripts/embassy.js`in the root of the project's wrapper repository.
4. Fill in the todos in the above template to match the expected Effect parameter defined by the `exported type <https://deno.land/x/embassyd_sdk@v0.3.1.0.3/types.ts#L32>`_. This type describes how to call functions that interact with EmbassyOS.
5. In the build process for packaging the final s9pk, include the following step. **The location of the js is important, and can't be changed**. It must exist at `scripts/embassy.js` in the root of the project's wrapper repository.
.. code:: bash