Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
import * as embassydSdk from "https://deno.land/x/embassyd_sdk@v0.3.4-alpha1/types.ts";

Type Aliases

Used to reach out from the pure js runtime

For backing up service data though the embassyOS UI

These are how we make sure the our dependency configurations are valid and if not how to fix them.

Get configuration returns a shape that describes the format that the embassy ui will generate, and later send to the set config

This is the entrypoint for the main container. Used to start up something like the service that the package represents, like running a bitcoind in a bitcoind-wrapper.

Properties are used to get values from the docker, like a username + password, what ports we are hosting from

For restoring service data that was previously backed up using the embassyOS UI create backup flow. Backup restores are also triggered via the embassyOS UI, or doing a system restore flow during setup.

Set configuration is called after we have modified and saved the configuration in the embassy ui. Use this to make a file for the docker to read from for configuration.