chore: add some documentation and somet testing

This commit is contained in:
BluJ
2022-07-18 13:27:51 -06:00
parent cb39f5f3ba
commit 17d4b8048f
7 changed files with 296 additions and 249 deletions

View File

@@ -1,33 +1,40 @@
import { YAML } from "../dependencies.ts";
import { ExpectedExports, Effects, Config, SetResult, DependsOn } from "../types.ts";
import {
Config,
DependsOn,
Effects,
ExpectedExports,
SetResult,
} from "../types.ts";
/**
* Will set the config to the default start9/config.yaml
* @param effects
* Assumption: start9/config.yaml is the location of the configuration
* @param effects
* @param newConfig Config to be written to start9/config.yaml
* @param depends_on This would be the depends on for condition depends_on
* @returns
* @returns
*/
export const setConfig = async (
effects: Effects,
newConfig: Config,
dependsOn: DependsOn = {}
effects: Effects,
newConfig: Config,
dependsOn: DependsOn = {},
) => {
await effects.createDir({
path: "start9",
volumeId: "main",
});
await effects.writeFile({
path: "start9/config.yaml",
toWrite: YAML.stringify(newConfig),
volumeId: "main",
});
await effects.createDir({
path: "start9",
volumeId: "main",
});
await effects.writeFile({
path: "start9/config.yaml",
toWrite: YAML.stringify(newConfig),
volumeId: "main",
});
const result: SetResult = {
signal: "SIGTERM",
"depends-on": dependsOn,
};
return { result, };
const result: SetResult = {
signal: "SIGTERM",
"depends-on": dependsOn,
};
return { result };
};
const _typeConversionCheck: ExpectedExports.setConfig = setConfig
const _typeConversionCheck: ExpectedExports.setConfig = setConfig;