Scripts

Overview

This page will cover scripts and how they are implemented and then how to use them. Scripts are essentially a way to define/program a task that can be run on demand via the Sodacore CLI program.

• Overview
• Creating a script

Creating a script

To create a script, we first need to import the Namespace and Script decorators alongside the type definitions.

import { Namespace, Script, type ScriptContext, type AsScript } from '@sodacore/core';

@Namespace('example')
export default class ExampleScript implements AsScript<ExampleScript> {

	@Script('hello')
	public hello(context: ScriptContext) {

		// Ask the user what their name is.
		const name = await context.prompts.text({
			message: 'What is your name?',
		});

		// If no return, or canceled, return true (this will send the user back to the menu).
		if (!name || name === 'canceled') return true;

		// Let's log the name to the user.
		context.log.info(`Hello ${name}!`);

		// Now return true to send them back to the menu.
		return true;
	}
}