frontity
Version:
Frontity cli and entry point to other packages
24 lines (23 loc) • 623 B
TypeScript
/**
* The options of the {@link subscribe} command.
*/
interface SubscribeOptions {
/**
* The email that will be subscribed to the newsletter service.
*
* It will be prompted if the CLI arg is missing.
*
* @example `name@domain.com`
*/
email: string;
}
/**
* The subscribe CLI command, usually run with `npx frontity subscribe`.
*
* It takes args from the CLI. Then, it runs the subscribe command
* programatically.
*
* @param options - Defined in {@link SubscribeOptions}.
*/
declare const subscribe: ({ email }: SubscribeOptions) => Promise<void>;
export default subscribe;