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

chore: charlie21

Browse Source
This commit is contained in:
BluJ
2023-04-14 17:53:08 -06:00
parent 3052bbe85d
commit f936f5ce35
5 changed files with 73 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
lib/types.ts
View File

@@ -1,5 +1,6 @@
export * as configTypes from "./config/configTypes";
import { InputSpec } from "./config/configTypes";
import { ActionReceipt } from "./init";
export namespace ExpectedExports {
version: 1;
@@ -13,8 +14,8 @@ export namespace ExpectedExports {
effects: Effects;
config: unknown;
}) => Promise<ConfigRes>;
/** These are how we make sure the our dependency configurations are valid and if not how to fix them. */
export type dependencies = Dependencies;
// /** These are how we make sure the our dependency configurations are valid and if not how to fix them. */
// export type dependencies = Dependencies;
/** For backing up service data though the embassyOS UI */
export type createBackup = (options: {
effects: Effects;
@@ -28,16 +29,13 @@ export namespace ExpectedExports {
effects: Effects;
}) => Promise<Properties | null | undefined | void>;
/** Health checks are used to determine if the service is working properly after starting
* A good use case is if we are using a web server, seeing if we can get to the web server.
*/
export type health = {
/** Should be the health check id */
[id: string]: (options: {
effects: Effects;
input: TimeMs;
}) => Promise<unknown>;
};
// /** Health checks are used to determine if the service is working properly after starting
// * A good use case is if we are using a web server, seeing if we can get to the web server.
// */
// export type health = {
// /** Should be the health check id */
// [id: string]: (options: { effects: Effects; input: TimeMs }) => Promise<unknown>;
// };
/**
* Actions are used so we can effect the service, like deleting a directory.
@@ -308,12 +306,12 @@ export type Effects = {
description: string;
id: string;
input: null | InputSpec;
runningOnly: boolean;
/**
* So the ordering of the actions is by alphabetical order of the group, then followed by the alphabetical of the actions
*/
group?: string;
}): Promise<void>;
}): Promise<void & ActionReceipt>;
/**
* Remove an action that was exported. Used problably during main or during setConfig.
*/
@@ -448,6 +446,11 @@ export type PackagePropertyString = {
qr?: boolean;
/** Hiding the value unless toggled off for field */
masked?: boolean;
watch?: {
packageId?: string;
path: string;
};
};
export type PackagePropertyObject = {
value: PackagePropertiesV2;